forked from bitweaver/liberty
/
LibertyAttachable.php
418 lines (370 loc) · 17.7 KB
/
LibertyAttachable.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
<?php
/**
* Management of Liberty Content
*
* @package liberty
* @version $Header$
* @author spider <spider@steelsun.com>
*/
// +----------------------------------------------------------------------+
// | Copyright (c) 2004, bitweaver.org
// +----------------------------------------------------------------------+
// | All Rights Reserved. See below for details and a complete list of authors.
// | Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See http://www.gnu.org/copyleft/lesser.html for details
// |
// | For comments, please use phpdocu.sourceforge.net documentation standards!!!
// | -> see http://phpdocu.sourceforge.net/
// +----------------------------------------------------------------------+
// | Authors: spider <spider@steelsun.com>
// +----------------------------------------------------------------------+
/**
* required setup
*/
require_once( LIBERTY_PKG_PATH.'LibertyContent.php' );
/**
* LibertyAttachable class
*
* @package liberty
*/
class LibertyAttachable extends LibertyContent {
var $mContentId;
var $mStorage;
function LibertyAttachable() {
parent::__construct();
}
// {{{ =================== Deprecated Methods ====================
/**
* TODO: This code is old and is not used by any package in the bitweaver CVS anymore.
* We will clean up this code as soon as we are sure that noone is using this code.
* Please look for the closing tripple '}' brackets to see where this section ends.
*/
/**
* fully load content and insert any attachments in $this->mStorage
* allow an optional content_id to be passed in to ease legacy lib style objects (like blogs, articles, etc.)
*
* @param array $pContentId
* @access public
* @return TRUE on success, FALSE on failure - mErrors will contain reason for failure
* @deprecated deprecated since version 2.1.0-beta
*/
/**
* TODO: This code is old and is not used by any package in the bitweaver CVS anymore.
* We will clean up this code as soon as we migrated all legacy code
*/
function load( $pContentId = NULL, $pPluginParams = NULL ) {
//deprecated( "This method has been replaced by a method in LibertyMime. Please try to migrate your code." );
// assume a derived class has joined on the liberty_content table, and loaded it's columns already.
global $gLibertySystem;
$conId = ( @$this->verifyId( $pContentId ) ? $pContentId : $this->mContentId );
if( @$this->verifyId( $conId ) ) {
LibertyContent::load( $conId );
$query = "
SELECT *
FROM `".BIT_DB_PREFIX."liberty_attachments` la
WHERE la.`content_id`=? ORDER BY la.`pos` ASC, la.`attachment_id` ASC";
if( $result = $this->mDb->query( $query,array( (int)$conId ))) {
$this->mStorage = array();
while( $row = $result->fetchRow() ) {
if( $func = $gLibertySystem->getPluginFunction( $row['attachment_plugin_guid'], 'load_function', 'mime' )) {
// this dummy is needed for forward compatability with LibertyMime plugins
$dummy = array();
$this->mStorage[$row['attachment_id']] = $func( $row, $dummy );
//$this->mStorage[$row['attachment_id']]['is_primary'] = !empty( $row['primary_attachment_id'] );
} else {
print "No load_function for ".$row['attachment_plugin_guid']." ".$gLibertySystem->mPlugins[$row['attachment_plugin_guid']];
}
}
}
}
return( TRUE );
}
/* store -- Stores any attachments
*
* pass $pParamHash['liberty_attachable']['skip_content_store'] == TRUE
* to avoid the underlying content store and simply store the attachments.
*
* verify() will shove things to store into $pParamHash['STORAGE'] to be
* gobbled up in this function.
*
* pass $pParamHash['liberty_attachable']['auto_primary'] == FALSE to turn off the auto
* primary on first attachment feature for a content type.
*
* @param hash $pParamHash The hash of arguments
*
* @deprecated deprecated since version 2.1.0-beta
*/
/**
* TODO: This code is old and is not used by any package in the bitweaver CVS anymore.
* We will clean up this code as soon as we migrated all legacy code
*/
function store( &$pParamHash ) {
//deprecated( "This method has been replaced by a method in LibertyMime. Please try to migrate your code." );
global $gLibertySystem, $gBitSystem, $gBitUser;
$this->mDb->StartTrans();
if( LibertyAttachable::verify( $pParamHash ) && ( isset($pParamHash['skip_content_store']) || LibertyContent::store( $pParamHash ) ) ) {
if(!empty( $pParamHash['STORAGE'] ) && count( $pParamHash['STORAGE'] ) ) {
foreach( array_keys( $pParamHash['STORAGE'] ) as $guid ) {
$storeRows = &$pParamHash['STORAGE'][$guid]; // short hand variable assignment
// If it is empty then nothing more to do. Avoid error in foreach.
if (empty($storeRows)) {
continue;
}
foreach( $storeRows as $key => $value ) {
$storeRow = &$pParamHash['STORAGE'][$guid][$key];
$storeRow['plugin_guid'] = $guid;
if (!@BitBase::verifyId($pParamHash['content_id'])) {
$storeRow['content_id'] = NULL;
} else {
$storeRow['content_id'] = $pParamHash['content_id']; // copy in content_id
}
if (!empty($pParamHash['user_id'])) {
$storeRow['user_id'] = $pParamHash['user_id']; // copy in the user_id
} else {
$storeRow['user_id'] = $gBitUser->mUserId;
}
// do we have a verify function for this storage type, and do things verify?
$verifyFunc = $gLibertySystem->getPluginFunction( $guid, 'verify_function' );
if( $verifyFunc && $verifyFunc( $storeRow ) ) {
// For backwards compatibility with a single upload.
if( @BitBase::verifyId( $pParamHash['attachment_id'] )) {
$storeRow['upload']['attachment_id'] = $storeRow['attachment_id'] = $pParamHash['attachment_id'];
} else if ( !isset($storeRow['skip_insert'] ) ) {
if ( defined( 'LINKED_ATTACHMENTS' ) && @BitBase::verifyId( $pParamHash['content_id'] ) ) {
$storeRow['upload']['attachment_id'] = $storeRow['attachment_id'] = $pParamHash['content_id'];
} else {
$storeRow['upload']['attachment_id'] = $storeRow['attachment_id'] =
defined( 'LINKED_ATTACHMENTS' ) ? $this->mDb->GenID( 'liberty_content_id_seq') : $this->mDb->GenID( 'liberty_attachments_id_seq' );
}
}
// if we have uploaded a file, we can take care of that generically
if( !empty( $storeRow['upload'] ) && is_array( $storeRow['upload'] ) && !empty( $storeRow['upload']['size'] ) ) {
if( empty( $storeRow['upload']['type'] ) ) {
$ext = substr( $storeRow['upload']['name'], strrpos( $storeRow['upload']['name'], '.' ) + 1 );
$storeRow['upload']['type'] = $gBitSystem->lookupMimeType( $ext );
}
$storeRow['upload']['dest_branch'] = $this->getStorageBranch( $storeRow['attachment_id'], $storeRow['user_id'], $this->getStorageSubDirName() );
if (!empty( $pParamHash['thumbnail_sizes'] ) ) {
$storeRow['upload']['thumbnail_sizes'] = $pParamHash['thumbnail_sizes'];
}
$storagePath = liberty_process_upload( $storeRow['upload'] );
// We're gonna store to local file system & liberty_files table
if( empty( $storagePath ) ) {
$this->mErrors['file'] = tra( "Could not store file" ).": ".$storeRow['upload']['name'].'.';
$storeRow['attachment_id'] = NULL;
$storeRow['upload']['attachment_id'] = NULL;
} else {
$storeRow['upload']['dest_file_path'] = $storagePath;
}
}
if( @BitBase::verifyId( $storeRow['attachment_id'] ) && $storeFunc = $gLibertySystem->getPluginFunction( $storeRow['plugin_guid'], 'store_function' )) {
$this->mStorage = $storeFunc( $storeRow );
}
// don't insert if we already have an entry with this attachment_id
if( @BitBase::verifyId( $storeRow['attachment_id'] ) && !isset( $storeRow['skip_insert'] ) && !LibertyMime::loadAttachment( $storeRow['attachment_id'] )) {
$sql = "INSERT INTO `".BIT_DB_PREFIX."liberty_attachments` ( `content_id`, `attachment_id`, `attachment_plugin_guid`, `foreign_id`, `user_id` ) VALUES ( ?, ?, ?, ?, ? )";
$rs = $this->mDb->query( $sql, array( $storeRow['content_id'], $storeRow['attachment_id'], $storeRow['plugin_guid'], (int)$storeRow['foreign_id'], $storeRow['user_id'] ) );
}
}
}
}
}
// set the primary attachment id
$this->setPrimaryAttachment(
$pParamHash['liberty_attachments']['primary'],
$pParamHash['content_id'],
empty( $pParamHash['liberty_attachments']['auto_primary'] ) || $pParamHash['liberty_attachments']['auto_primary'] ? TRUE : FALSE
);
}
$this->mDb->CompleteTrans();
return( count( $this->mErrors ) == 0 );
}
/**
* verifyAttachment
*
* @param array $pParamHash
* @param array $pFile
* @param array $pKey
* @access public
* @return TRUE on success, FALSE on failure - mErrors will contain reason for failure
* @deprecated deprecated since version 2.1.0-beta
*/
function verifyAttachment( &$pParamHash, $pFile, $pKey ) {
//deprecated( "This method has been replaced by a method in LibertyMime. Please try to migrate your code." );
global $gBitSystem, $gBitUser, $gLibertySystem;
if( !empty( $pFile ) && !empty( $pFile['size'] ) ) {
if( empty( $pParamHash['storage_guid'] )) {
// only file format storage available at present
$pParamHash['storage_guid'] = $storageGuid = PLUGIN_GUID_BIT_FILES;
} else {
$storageGuid = $pParamHash['storage_guid'];
}
if( !empty( $pFile['size'] ) ) {
$this->extractMetaData( $pParamHash, $pFile );
// meta data may be stupid and have stuffed title with all spaces
if( !empty( $pParamHash['title'] ) ) {
$pParamHash['title'] = trim( $pParamHash['title'] );
}
// let's add a default title
if( empty( $pParamHash['title'] ) && !empty( $pFile['name'] ) ) {
if( preg_match( '/^[A-Z]:\\\/', $pFile['name'] ) ) {
// MSIE shit file names if passthrough via gigaupload, etc.
// basename will not work - see http://us3.php.net/manual/en/function.basename.php
$tmp = preg_split("#[\\\]#",$pFile['name']);
$defaultName = $tmp[count($tmp) - 1];
} elseif( strpos( '.', $pFile['name'] ) ) {
list( $defaultName, $ext ) = explode( '.', $pFile['name'] );
} else {
$defaultName = $pFile['name'];
}
$pParamHash['title'] = str_replace( '_', ' ', substr( $defaultName, 0, strrpos( $defaultName, '.' ) ) );
}
if ( !is_windows() ) {
list( $pFile['name'], $pFile['type'] ) = $gBitSystem->verifyFileExtension( $pFile['tmp_name'], $pFile['name'] );
} else {
//$pFile['type'] = $gBitSystem->verifyMimeType( $pFile['tmp_name'] );
}
// clean out crap that can make life difficult in server maintenance
$cleanedBaseName = preg_replace( '/[&\%:\/\\\]/', '', substr( $pFile['name'], 0, strrpos( $pFile['name'], '.' ) ) );
$pFile['dest_base_name'] = $cleanedBaseName;
$pFile['source_file'] = $pFile['tmp_name'];
// lowercase all file extensions
$pFile['name'] = $cleanedBaseName.strtolower( substr( $pFile['name'], strrpos( $pFile['name'], '.' ) ) );
if (!isset($pParamHash['STORAGE'][$storageGuid])) {
$pParamHash['STORAGE'][$storageGuid] = array();
}
$pParamHash['STORAGE'][$storageGuid][$pKey] = array('upload' => &$pFile);
}
}
}
/**
* verify - standard API method, with a twist. It will gobble up anything in $_FILES if available, unless an array of arrays is passed in to $pParamHash['_files_override']
*
* @access private
* @author Christian Fowler<spider@steelsun.com>
* @param $pParamHash
* @return FALSE if errors were present, TRUE meaning object is ready to store
* @deprecated deprecated since version 2.1.0-beta
*/
function verify( &$pParamHash ) {
//deprecated( "This method has been replaced by a method in LibertyMime. Please try to migrate your code." );
global $gBitSystem, $gBitUser;
// check to see if we have any files to upload
if( isset( $pParamHash['_files_override'] ) ) {
// we have been passed in a manually stuffed files attachment, such as a custom uploader would have done.
// process this, and skip over $_FILES
$uploads = $pParamHash['_files_override'];
} elseif( !empty( $_FILES ) ) {
// we have some _FILES hanging around we will gobble up. This is inherently dagnerous chewing up a _FILES like this as
// it can cause premature storing of a _FILE if you are trying to store multiple pieces of content at once.
foreach( $_FILES as $key => $file ) {
if( !empty( $file['name'] )) {
$uploads[$key] = $file;
}
}
}
// don't check for p_liberty_attach_attachments permission on bitpermuser class so registration with avatar upload works
if( strtolower( get_class( $this )) == 'bitpermuser' ) {
$pParamHash['no_perm_check'] = TRUE;
}
// check for the required permissions to upload a file to the liberty attachments area
if( !empty( $uploads ) && empty( $pParamHash['no_perm_check'] )) {
if( !$gBitUser->hasPermission( 'p_liberty_attach_attachments' )) {
$this->mErrors['permission'] = tra( 'You do not have permission to upload attachments.' );
}
}
if( !empty( $pParamHash['attachment_id'] ) && !$this->verifyId( $pParamHash['attachment_id'] ) ) {
$this->mErrors['file'] = tra('System Error: Non-numeric storage_id.');
}
if( empty( $pParamHash['user_id'] ) ) {
// storage is always owned by the user that uploaded it!
// er... or at least admin if somehow we have a NULL mUserId - anon uploads maybe?
$pParamHash['user_id'] = @$this->verifyId( $gBitUser->mUserId ) ? $gBitUser->mUserId : ROOT_USER_ID;
}
if( empty( $pParamHash['process_storage'] ) ) {
$pParamHash['process_storage'] = NULL;
}
if( empty( $pParamHash['subdir'] ) ) {
$pParamHash['subdir'] = 'files';
}
if( !empty( $uploads ) ) {
foreach( array_keys( $uploads ) as $f ) {
$this->verifyAttachment( $pParamHash, $uploads[$f], $f );
}
}
// primary attachment. Allow 'none' to clear the primary.
if( !@BitBase::verifyId( $pParamHash['liberty_attachments']['primary'] ) && ( empty( $pParamHash['liberty_attachments']['primary'] ) || $pParamHash['liberty_attachments']['primary'] != 'none' ) ) {
$pParamHash['liberty_attachments']['primary'] = NULL;
}
// if we have an error we get them all by checking parent classes for additional errors
if( count( $this->mErrors ) > 0 ){
parent::verify( $pParamHash );
}
return ( count( $this->mErrors ) == 0 );
}
/**
* extractMetaData extract meta data from images
*
* @param array $pParamHash
* @param array $pFile
* @access public
* @return TRUE on success, FALSE on failure - mErrors will contain reason for failure
* @deprecated deprecated since version 2.1.0-beta
*/
function extractMetaData( &$pParamHash, &$pFile ) {
//deprecated( "This method has been replaced by a method in LibertyMime. Please try to migrate your code." );
// Process a JPEG , jpeg_metadata_tk REQUIRES short_tags because that is the way it was written. feel free to fix something. XOXO spiderr
if( ini_get( 'short_open_tag' ) && function_exists( 'exif_read_data' ) && !empty( $pFile['tmp_name'] ) && strpos( strtolower($pFile['type']), 'jpeg' ) !== FALSE ) {
$exifHash = @exif_read_data( $pFile['tmp_name'], 0, true);
// Change: Allow this example file to be easily relocatable - as of version 1.11
require_once UTIL_PKG_PATH.'jpeg_metadata_tk/JPEG.php';
require_once UTIL_PKG_PATH.'jpeg_metadata_tk/JFIF.php';
require_once UTIL_PKG_PATH.'jpeg_metadata_tk/PictureInfo.php';
require_once UTIL_PKG_PATH.'jpeg_metadata_tk/XMP.php';
require_once UTIL_PKG_PATH.'jpeg_metadata_tk/EXIF.php';
// Retrieve the header information from the JPEG file
$jpeg_header_data = get_jpeg_header_data( $pFile['tmp_name'] );
// Retrieve EXIF information from the JPEG file
$Exif_array = get_EXIF_JPEG( $pFile['tmp_name'] );
// Retrieve XMP information from the JPEG file
$XMP_array = read_XMP_array_from_text( get_XMP_text( $jpeg_header_data ) );
// Retrieve Photoshop IRB information from the JPEG file
$IRB_array = get_Photoshop_IRB( $jpeg_header_data );
if( !empty( $exifHash['IFD0']['Software'] ) && preg_match( '/photoshop/i', $exifHash['IFD0']['Software'] ) ) {
require_once UTIL_PKG_PATH.'jpeg_metadata_tk/Photoshop_File_Info.php';
// Retrieve Photoshop File Info from the three previous arrays
$psFileInfo = get_photoshop_file_info( $Exif_array, $XMP_array, $IRB_array );
if( !empty( $psFileInfo['headline'] ) ) {
if( empty( $pParamHash['title'] ) ) {
$pParamHash['title'] = $psFileInfo['headline'];
} elseif( empty( $pParamHash['edit'] ) && !$this->getField( 'data' ) && $pParamHash['title'] != $psFileInfo['headline'] ) {
$pParamHash['edit'] = $psFileInfo['headline'];
}
}
if( !empty( $psFileInfo['caption'] ) ) {
if( empty( $pParamHash['title'] ) ) {
$pParamHash['title'] = $psFileInfo['caption'];
} elseif( empty( $pParamHash['edit'] ) && !$this->getField( 'data' ) && $pParamHash['title'] != $psFileInfo['caption'] ) {
$pParamHash['edit'] = $psFileInfo['caption'];
}
}
}
if( !empty( $exifHash['EXIF']['DateTimeOriginal'] ) ) {
$pParamHash['event_time'] = strtotime( $exifHash['EXIF']['DateTimeOriginal'] );
}
if( !empty( $exifHash['IFD0']['ImageDescription'] ) ) {
if( empty( $pParamHash['title'] ) ) {
$pParamHash['title'] = $exifHash['IFD0']['ImageDescription'];
} elseif( empty( $pParamHash['edit'] ) && !$this->getField( 'data' ) && $pParamHash['title'] != $exifHash['IFD0']['ImageDescription'] ) {
$pParamHash['edit'] = $exifHash['IFD0']['ImageDescription'];
}
}
}
}
// }}}
}
// FIXME: this is really dirty and needs to go away from here
// make sure LibertyMime is available during this transition phase
// we need to call this down here since LM extends LA and can't be included before LA is available
require_once( LIBERTY_PKG_PATH.'LibertyMime.php' );
/* vim: :set fdm=marker : */
?>