#636548: List files by default only checks box for first file.
[project/filefield.git] / filefield_widget.inc
1 <?php
2 // $Id$
3
4 /**
5 * @file
6 * This file contains CCK widget related functionality.
7 *
8 * Uses content.module to store the fid and field specific metadata,
9 * and Drupal's files table to store the actual file data.
10 */
11
12 /**
13 * Implementation of CCK's hook_widget_settings($op == 'form').
14 */
15 function filefield_widget_settings_form($widget) {
16 $form = array();
17 $form['file_extensions'] = array(
18 '#type' => 'textfield',
19 '#title' => t('Permitted upload file extensions'),
20 '#default_value' => is_string($widget['file_extensions']) ? $widget['file_extensions'] : 'txt',
21 '#size' => 64,
22 '#description' => t('Extensions a user can upload to this field. Separate extensions with a space and do not include the leading dot. Leaving this blank will allow users to upload a file with any extension.'),
23 '#weight' => 1,
24 );
25
26 $form['progress_indicator'] = array(
27 '#type' => 'radios',
28 '#title' => t('Progress indicator'),
29 '#options' => array(
30 'bar' => t('Bar with progress meter'),
31 'throbber' => t('Throbber'),
32 ),
33 '#default_value' => empty($widget['progress_indicator']) ? 'bar' : $widget['progress_indicator'],
34 '#description' => t('Your server supports upload progress capabilities. The "throbber" display does not indicate progress but takes up less room on the form, you may want to use it if you\'ll only be uploading small files or if experiencing problems with the progress bar.'),
35 '#weight' => 5,
36 '#access' => filefield_progress_implementation(),
37 );
38
39 $form['path_settings'] = array(
40 '#type' => 'fieldset',
41 '#title' => t('Path settings'),
42 '#collapsible' => TRUE,
43 '#collapsed' => TRUE,
44 '#weight' => 6,
45 );
46 $form['path_settings']['file_path'] = array(
47 '#type' => 'textfield',
48 '#title' => t('File path'),
49 '#default_value' => is_string($widget['file_path']) ? $widget['file_path'] : '',
50 '#description' => t('Optional subdirectory within the "%directory" directory where files will be stored. Do not include preceding or trailing slashes.', array('%directory' => variable_get('file_directory_path', 'files') . '/')),
51 '#element_validate' => array('_filefield_widget_settings_file_path_validate'),
52 '#suffix' => theme('token_help', 'user'),
53 );
54
55 $form['max_filesize'] = array(
56 '#type' => 'fieldset',
57 '#title' => t('File size restrictions'),
58 '#description' => t('Limits for the size of files that a user can upload. Note that these settings only apply to newly uploaded files, whereas existing files are not affected.'),
59 '#weight' => 6,
60 '#collapsible' => TRUE,
61 '#collapsed' => TRUE,
62 );
63 $form['max_filesize']['max_filesize_per_file'] = array(
64 '#type' => 'textfield',
65 '#title' => t('Maximum upload size per file'),
66 '#default_value' => is_string($widget['max_filesize_per_file'])
67 ? $widget['max_filesize_per_file']
68 : '',
69 '#description' => t('Specify the size limit that applies to each file separately. Enter a value like "512" (bytes), "80K" (kilobytes) or "50M" (megabytes) in order to restrict the allowed file size. If you leave this this empty the file sizes will be limited only by PHP\'s maximum post and file upload sizes (current limit <strong>%limit</strong>).', array('%limit' => format_size(file_upload_max_size()))),
70 '#element_validate' => array('_filefield_widget_settings_max_filesize_per_file_validate'),
71 );
72 $form['max_filesize']['max_filesize_per_node'] = array(
73 '#type' => 'textfield',
74 '#title' => t('Maximum upload size per node'),
75 '#default_value' => is_string($widget['max_filesize_per_node'])
76 ? $widget['max_filesize_per_node']
77 : '',
78 '#description' => t('Specify the total size limit for all files in field on a given node. Enter a value like "512" (bytes), "80K" (kilobytes) or "50M" (megabytes) in order to restrict the total size of a node. Leave this empty if there should be no size restriction.'),
79 '#element_validate' => array('_filefield_widget_settings_max_filesize_per_node_validate'),
80 );
81
82 return $form;
83 }
84
85 /**
86 * Implementation of CCK's hook_widget_settings($op == 'save').
87 */
88 function filefield_widget_settings_save($widget) {
89 return array('file_extensions', 'file_path', 'progress_indicator', 'max_filesize_per_file', 'max_filesize_per_node');
90 }
91
92 function _filefield_widget_settings_file_path_validate($element, &$form_state) {
93 // Strip slashes from the beginning and end of $widget['file_path']
94 $form_state['values']['file_path'] = trim($form_state['values']['file_path'], '\\/');
95
96 // Do not allow the file path to be the same as the file_directory_path().
97 // This causes all sorts of problems with things like file_create_url().
98 if (strpos($form_state['values']['file_path'], file_directory_path()) === 0) {
99 form_error($element, t('The file path (@file_path) cannot start with the system files directory (@files_directory), as this may cause conflicts when building file URLs.', array('@file_path' => $form_state['values']['file_path'], '@files_directory' => file_directory_path())));
100 }
101 }
102
103 function _filefield_widget_settings_max_filesize_per_file_validate($element, &$form_state) {
104 if (empty($form_state['values']['max_filesize_per_file'])) {
105 return; // Empty means no size restrictions, so don't throw an error.
106 }
107 elseif (!is_numeric(parse_size($form_state['values']['max_filesize_per_file']))) {
108 form_error($element, t('The "@field" option must contain a valid value. You can either leave the text field empty or enter a string like "512" (bytes), "80K" (kilobytes) or "50M" (megabytes).', array('@field' => t('Maximum upload size per file'))));
109 }
110 }
111
112 function _filefield_widget_settings_max_filesize_per_node_validate($element, &$form_state) {
113 if (empty($form_state['values']['max_filesize_per_node'])) {
114 return; // Empty means no size restrictions, so don't throw an error.
115 }
116 elseif (!is_numeric(parse_size($form_state['values']['max_filesize_per_node']))) {
117 form_error($element, t('The "@field" option must contain a valid value. You can either leave the text field empty or enter a string like "512" (bytes), "80K" (kilobytes) or "50M" (megabytes).', array('@field' => t('Maximum upload size per node'))));
118 }
119 }
120
121 /**
122 * Determine the widget's files directory
123 *
124 * @param $field
125 * A CCK field array.
126 * @param $account
127 * The user account object to calculate the file path for.
128 * @return
129 * The files directory path, with any tokens replaced.
130 */
131 function filefield_widget_file_path($field, $account = NULL) {
132 $account = isset($account) ? $account : $GLOBALS['user'];
133 $dest = $field['widget']['file_path'];
134 // Replace user level tokens.
135 // Node level tokens require a lot of complexity like temporary storage
136 // locations when values don't exist. See the filefield_paths module.
137 if (module_exists('token')) {
138 $dest = token_replace($dest, 'user', $account);
139 }
140 // Replace nasty characters in the path if possible.
141 if (module_exists('transliteration')) {
142 module_load_include('inc', 'transliteration');
143 $dest_array = array_filter(explode('/', $dest));
144 foreach ($dest_array as $key => $directory) {
145 $dest_array[$key] = transliteration_clean_filename($directory);
146 }
147 $dest = implode('/', $dest_array);
148 }
149
150 return file_directory_path() .'/'. $dest;
151 }
152
153 /**
154 * Given a FAPI element, save any files that may have been uploaded into it.
155 *
156 * This function should only be called during validate, submit, or
157 * value_callback functions.
158 *
159 * @param $element
160 * The FAPI element whose values are being saved.
161 */
162 function filefield_save_upload($element) {
163 $upload_name = $element['#field_name'] .'_'. $element['#delta'];
164 $field = content_fields($element['#field_name'], $element['#type_name']);
165
166 if (empty($_FILES['files']['name'][$upload_name])) {
167 return 0;
168 }
169
170 $dest = filefield_widget_file_path($field);
171 if (!field_file_check_directory($dest, FILE_CREATE_DIRECTORY)) {
172 watchdog('filefield', 'The upload directory %directory for the file field %field (content type %type) could not be created or is not accessible. A newly uploaded file could not be saved in this directory as a consequence, and the upload was canceled.', array('%directory' => $dest, '%field' => $element['#field_name'], '%type' => $element['#type_name']));
173 form_set_error($upload_name, t('The file could not be uploaded.'));
174 return 0;
175 }
176
177 if (!$file = field_file_save_upload($upload_name, $element['#upload_validators'], $dest)) {
178 watchdog('filefield', 'The file upload failed. %upload', array('%upload' => $upload_name));
179 form_set_error($upload_name, t('The file in the @field field was unable to be uploaded.', array('@field' => $element['#title'])));
180 return 0;
181 }
182 return $file['fid'];
183 }
184
185 /**
186 * The #value_callback for the filefield_widget type element.
187 */
188 function filefield_widget_value($element, $edit = FALSE) {
189 if (!$edit) {
190 $file = field_file_load($element['#default_value']['fid']);
191 $item = $element['#default_value'];
192 }
193 else {
194 $item = array_merge($element['#default_value'], $edit);
195 $field = content_fields($element['#field_name'], $element['#type_name']);
196
197 // Uploads take priority over value of fid text field.
198 if ($fid = filefield_save_upload($element)) {
199 $item['fid'] = $fid;
200 }
201 // Check for #filefield_value_callback values.
202 // Because FAPI does not allow multiple #value_callback values like it does
203 // for #element_validate and #process, this fills the missing functionality
204 // to allow FileField to be extended purely through FAPI.
205 elseif (isset($element['#filefield_value_callback'])) {
206 foreach ($element['#filefield_value_callback'] as $callback) {
207 $callback($element, $item);
208 }
209 }
210
211 // Load file if the FID has changed so that it can be saved by CCK.
212 $file = field_file_load($item['fid']);
213
214 // If the file entry doesn't exist, don't save anything.
215 if (empty($file)) {
216 $item = array();
217 }
218
219 // Checkboxes loose their value when empty.
220 // If the list field is present make sure its unchecked value is saved.
221 if (!empty($field['list_field']) && empty($edit['list'])) {
222 $item['list'] = 0;
223 }
224 }
225 // Merge file and item data so it is available to all widgets.
226 $item = array_merge($item, $file);
227
228 return $item;
229 }
230
231 /**
232 * An element #process callback for the filefield_widget field type.
233 *
234 * Expands the filefield_widget type to include the upload field, upload and
235 * remove buttons, and the description field.
236 */
237 function filefield_widget_process($element, $edit, &$form_state, $form) {
238 // The widget is being presented, so apply the JavaScript.
239 drupal_add_js(drupal_get_path('module', 'filefield') .'/filefield.js');
240
241 $item = $element['#value'];
242 $field_name = $element['#field_name'];
243 $delta = $element['#delta'];
244 $element['#theme'] = 'filefield_widget_item';
245
246 $field = $form['#field_info'][$field_name];
247
248 // Title is not necessary for each individual field.
249 if ($field['multiple'] > 0) {
250 unset($element['#title']);
251 }
252
253 // Set up the buttons first since we need to check if they were clicked.
254 $element['filefield_upload'] = array(
255 '#type' => 'submit',
256 '#value' => t('Upload'),
257 '#submit' => array('node_form_submit_build_node'),
258 '#ahah' => array( // with JavaScript
259 'path' => 'filefield/ahah/'. $element['#type_name'] .'/'. $element['#field_name'] .'/'. $element['#delta'],
260 'wrapper' => $element['#id'] .'-ahah-wrapper',
261 'method' => 'replace',
262 'effect' => 'fade',
263 ),
264 '#field_name' => $element['#field_name'],
265 '#delta' => $element['#delta'],
266 '#type_name' => $element['#type_name'],
267 '#upload_validators' => $element['#upload_validators'],
268 '#weight' => 100,
269 '#post' => $element['#post'],
270 );
271 $element['filefield_remove'] = array(
272 // With default CCK edit forms, $element['#parents'] is array($element['#field_name'], $element['#delta']).
273 // However, if some module (for example, flexifield) places our widget deeper in the tree, we want to
274 // use that information in constructing the button name.
275 '#name' => implode('_', $element['#parents']) .'_filefield_remove',
276 '#type' => 'submit',
277 '#value' => t('Remove'),
278 '#submit' => array('node_form_submit_build_node'),
279 '#ahah' => array( // with JavaScript
280 'path' => 'filefield/ahah/'. $element['#type_name'] .'/'. $element['#field_name'] .'/'. $element['#delta'],
281 'wrapper' => $element['#id'] .'-ahah-wrapper',
282 'method' => 'replace',
283 'effect' => 'fade',
284 ),
285 '#field_name' => $element['#field_name'],
286 '#delta' => $element['#delta'],
287 '#weight' => 101,
288 '#post' => $element['#post'],
289 );
290
291 // Because the output of this field changes depending on the button clicked,
292 // we need to ask FAPI immediately if the remove button was clicked.
293 // It's not good that we call this private function, but
294 // $form_state['clicked_button'] is only available after this #process
295 // callback is finished.
296 if (_form_button_was_clicked($element['filefield_remove'])) {
297 // Delete the file if it is currently unused. Note that field_file_delete()
298 // does a reference check in addition to our basic status check.
299 if (isset($edit['fid'])) {
300 $removed_file = field_file_load($edit['fid']);
301 if ($removed_file['status'] == 0) {
302 field_file_delete($removed_file);
303 }
304 }
305 $item = array('fid' => 0, 'list' => $field['list_default'], 'data' => array('description' => ''));
306 }
307
308 // Set access on the buttons.
309 $element['filefield_upload']['#access'] = empty($item['fid']);
310 $element['filefield_remove']['#access'] = !empty($item['fid']);
311
312 // Add progress bar support to the upload if possible.
313 $progress_indicator = isset($field['widget']['progress_indicator']) ? $field['widget']['progress_indicator'] : 'bar';
314 if ($progress_indicator != 'throbber' && $implementation = filefield_progress_implementation()) {
315 $upload_progress_key = md5(mt_rand());
316
317 if ($implementation == 'uploadprogress') {
318 $element['UPLOAD_IDENTIFIER'] = array(
319 '#type' => 'hidden',
320 '#value' => $upload_progress_key,
321 '#attributes' => array('class' => 'filefield-progress'),
322 );
323 }
324 elseif ($implementation == 'apc') {
325 $element['APC_UPLOAD_PROGRESS'] = array(
326 '#type' => 'hidden',
327 '#value' => $upload_progress_key,
328 '#attributes' => array('class' => 'filefield-progress'),
329 );
330 }
331
332 // Add the upload progress callback.
333 $element['filefield_upload']['#ahah']['progress']['type'] = 'bar';
334 $element['filefield_upload']['#ahah']['progress']['path'] = 'filefield/progress/' . $upload_progress_key;
335 }
336
337 // Set the FID.
338 $element['fid'] = array(
339 '#type' => 'hidden',
340 '#value' => $item['fid'],
341 );
342
343 if ($item['fid'] != 0) {
344 $element['preview'] = array(
345 '#type' => 'markup',
346 '#value' => theme('filefield_widget_preview', $item),
347 );
348 }
349
350 // placeholder.. will be serialized into the data column. this is a place for widgets
351 // to put additional data.
352 $element['data'] = array(
353 '#tree' => 'true',
354 '#access' => !empty($item['fid']),
355 );
356
357 if (!empty($field['description_field'])) {
358 $element['data']['description'] = array(
359 '#type' => 'textfield',
360 '#title' => t('Description'),
361 '#value' => isset($item['data']['description']) ? $item['data']['description'] : '',
362 '#type' => variable_get('filefield_description_type', 'textfield'),
363 '#maxlength' => variable_get('filefield_description_length', 128),
364 );
365 }
366
367 if (!empty($field['list_field'])) {
368 $element['list'] = array(
369 '#type' => empty($item['fid']) ? 'hidden' : 'checkbox',
370 '#title' => t('List'),
371 '#value' => isset($item['list']) && !empty($item['fid']) ? $item['list'] : $field['list_default'],
372 '#attributes' => array('class' => 'filefield-list'),
373 );
374 }
375 else {
376 $element['list'] = array(
377 '#type' => 'hidden',
378 '#value' => '1',
379 );
380 }
381
382 foreach ($element['#upload_validators'] as $callback => $arguments) {
383 $help_func = $callback .'_help';
384 if (function_exists($help_func)) {
385 $desc[] = call_user_func_array($help_func, $arguments);
386 }
387 }
388 $element['upload'] = array(
389 '#name' => 'files['. $element['#field_name'] .'_'. $element['#delta'] .']',
390 '#type' => 'file',
391 '#description' => implode('<br />', $desc),
392 '#size' => 22,
393 '#attributes' => array(
394 'accept' => implode(',', array_filter(explode(' ', $field['widget']['file_extensions']))),
395 ),
396 '#access' => empty($item['fid']),
397 );
398
399 $element['#attributes']['id'] = $element['#id'] .'-ahah-wrapper';
400 $element['#prefix'] = '<div '. drupal_attributes($element['#attributes']) .'>';
401 $element['#suffix'] = '</div>';
402
403 return $element;
404 }
405
406 /**
407 * An #element_validate callback for the filefield_widget field.
408 */
409 function filefield_widget_validate(&$element, &$form_state) {
410 // If referencing an existing file, only allow if there are existing
411 // references. This prevents unmanaged files (outside of FileField) from
412 // being deleted if this node were to be deleted.
413 if (!empty($element['fid']['#value'])) {
414 $field = content_fields($element['#field_name'], $element['#type_name']);
415 if ($file = field_file_load($element['fid']['#value'])) {
416 $file = (object) $file;
417 if ($file->status == FILE_STATUS_PERMANENT) {
418 // TODO: We could use field_file_references() here to reference any file
419 // but hook_file_delete() needs to be implemented first.
420 $references = module_invoke('filefield', 'file_references', $file);
421 if ($references['filefield'] == 0) {
422 form_error($element, t('Referencing to the file used in the %field field is not allowed.', array('%field' => $element['#title'])));
423 }
424 }
425 }
426 else {
427 form_error($element, t('The file referenced by the %field field does not exist.', array('%field' => $element['#title'])));
428 }
429 }
430 }
431
432 /**
433 * FormAPI theme function. Theme the output of an image field.
434 */
435 function theme_filefield_widget($element) {
436 return theme('form_element', $element, $element['#children']);
437 }
438
439 function theme_filefield_widget_preview($item) {
440 // Remove the current description so that we get the filename as the link.
441 if (isset($item['data']['description'])) {
442 unset($item['data']['description']);
443 }
444
445 return '<div class="filefield-file-info">'.
446 '<div class="filename">'. theme('filefield_file', $item) .'</div>'.
447 '<div class="filesize">'. format_size($item['filesize']) .'</div>'.
448 '<div class="filemime">'. $item['filemime'] .'</div>'.
449 '</div>';
450 }
451
452 function theme_filefield_widget_item($element) {
453 // Put the upload button directly after the upload field.
454 $element['upload']['#field_suffix'] = drupal_render($element['filefield_upload']);
455 $element['upload']['#theme'] = 'filefield_widget_file';
456
457 $output = '';
458 $output .= '<div class="filefield-element clear-block">';
459
460 if ($element['fid']['#value'] != 0) {
461 $output .= '<div class="widget-preview">';
462 $output .= drupal_render($element['preview']);
463 $output .= '</div>';
464 }
465
466 $output .= '<div class="widget-edit">';
467 $output .= drupal_render($element);
468 $output .= '</div>';
469 $output .= '</div>';
470
471 return $output;
472 }
473
474 /**
475 * Custom theme function for FileField upload elements.
476 *
477 * This function allows us to put the "Upload" button immediately after the
478 * file upload field by respecting the #field_suffix property.
479 */
480 function theme_filefield_widget_file($element) {
481 $output = '';
482
483 $output .= '<div class="filefield-upload clear-block">';
484
485 if (isset($element['#field_prefix'])) {
486 $output .= $element['#field_prefix'];
487 }
488
489 _form_set_class($element, array('form-file'));
490 $output .= '<input type="file" name="'. $element['#name'] .'"'. ($element['#attributes'] ? ' '. drupal_attributes($element['#attributes']) : '') .' id="'. $element['#id'] .'" size="'. $element['#size'] ."\" />\n";
491
492 if (isset($element['#field_suffix'])) {
493 $output .= $element['#field_suffix'];
494 }
495
496 $output .= '</div>';
497
498 return theme('form_element', $element, $output);
499 }
500
501 /**
502 * Additional #validate handler for the node form.
503 *
504 * This function checks the #required properties on file fields and calculates
505 * node upload totals for all file fields. The #required property is not
506 * properly supported on file fields by Drupal core, so we do this manually.
507 */
508 function filefield_node_form_validate($form, &$form_state) {
509 $type = content_types($form['type']['#value']);
510 foreach ($type['fields'] as $field_name => $field) {
511 if (!(in_array($field['module'], array('imagefield', 'filefield')))) continue;
512 $empty = $field['module'] .'_content_is_empty';
513 $valid = FALSE;
514 $total_filesize = 0;
515 if (!empty($form_state['values'][$field_name])) {
516 foreach ($form_state['values'][$field_name] as $delta => $item) {
517 if ($empty($item, $field)) continue;
518 $valid = TRUE;
519 $total_filesize += (int)$item['filesize'];
520 }
521 }
522
523 if (!$valid && $field['required']) {
524 form_set_error($field_name, t('%title field is required.', array('%title' => $field['widget']['label'])));
525 }
526 $max_filesize = parse_size($field['widget']['max_filesize_per_node']);
527 if ($max_filesize && $total_filesize > $max_filesize) {
528 form_set_error($field_name, t('Total filesize for %title, %tsize, exceeds field settings of %msize.',
529 array(
530 '%title' => $field['widget']['label'],
531 '%tsize' => format_size($total_filesize),
532 '%msize' => format_size($max_filesize)
533 )
534 ));
535 }
536 }
537 }