Newer
Older
Dries Buytaert
committed
<?php
// $Id$
/**
* @file
* Defines a "managed_file" Form API field and a "file" field for Field module.
*/
Angie Byron
committed
// Load all Field module hooks for File.
require_once DRUPAL_ROOT . '/modules/file/file.field.inc';
/**
* Implements hook_help().
*/
function file_help($path, $arg) {
switch ($path) {
case 'admin/help#file':
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The File module defines a <em>File</em> field type for the Field module, which lets you manage and validate uploaded files attached to content on your site (see the <a href="@field-help">Field module help page</a> for more information about fields). For more information, see the online handbook entry for <a href="@file">File module</a>.', array('@field-help' => url('admin/help/field'), '@file' => 'http://drupal.org/handbook/modules/file')) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Attaching files to content') . '</dt>';
$output .= '<dd>' . t('The File module allows users to attach files to content (e.g., PDF files, spreadsheets, etc.), when a <em>File</em> field is added to a given content type using the <a href="@fieldui-help">Field UI module</a>. You can add validation options to your File field, such as specifying a maximum file size and allowed file extensions.', array('@fieldui-help' => url('admin/help/field_ui'))) . '</dd>';
$output .= '<dt>' . t('Managing attachment display') . '</dt>';
$output .= '<dd>' . t('When you attach a file to content, you can specify whether it is <em>listed</em> or not. Listed files are displayed automatically in a section at the bottom of your content; non-listed files are available for embedding in your content, but are not included in the list at the bottom.') . '</dd>';
$output .= '<dt>' . t('Managing file locations') . '</dt>';
$output .= '<dd>' . t("When you create a File field, you can specify a directory where the files will be stored, which can be within either the <em>public</em> or <em>private</em> files directory. Files in the public directory can be accessed directly through the web server; when public files are listed, direct links to the files are used, and anyone who knows a file's URL can download the file. Files in the private directory are not accessible directly through the web server; when private files are listed, the links are Drupal path requests. This adds to server load and download time, since Drupal must start up and resolve the path for each file download request, but allows for access restrictions.") . '</dd>';
$output .= '</dl>';
return $output;
}
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_menu().
Dries Buytaert
committed
*/
function file_menu() {
$items = array();
$items['file/ajax'] = array(
'page callback' => 'file_ajax_upload',
Dries Buytaert
committed
'delivery callback' => 'ajax_deliver',
Dries Buytaert
committed
'access arguments' => array('access content'),
Dries Buytaert
committed
'theme callback' => 'ajax_base_page_theme',
Dries Buytaert
committed
'type' => MENU_CALLBACK,
);
$items['file/progress'] = array(
'page callback' => 'file_ajax_progress',
Dries Buytaert
committed
'delivery callback' => 'ajax_deliver',
Dries Buytaert
committed
'access arguments' => array('access content'),
Dries Buytaert
committed
'theme callback' => 'ajax_base_page_theme',
Dries Buytaert
committed
'type' => MENU_CALLBACK,
);
return $items;
}
/**
Dries Buytaert
committed
* Implements hook_element_info().
Dries Buytaert
committed
*
* The managed file element may be used independently anywhere in Drupal.
Dries Buytaert
committed
*/
Dries Buytaert
committed
function file_element_info() {
Dries Buytaert
committed
$file_path = drupal_get_path('module', 'file');
Dries Buytaert
committed
$types['managed_file'] = array(
Dries Buytaert
committed
'#input' => TRUE,
'#process' => array('file_managed_file_process'),
'#value_callback' => 'file_managed_file_value',
'#element_validate' => array('file_managed_file_validate'),
'#pre_render' => array('file_managed_file_pre_render'),
Dries Buytaert
committed
'#theme' => 'file_managed_file',
'#theme_wrappers' => array('form_element'),
'#progress_indicator' => 'throbber',
'#progress_message' => NULL,
'#upload_validators' => array(),
'#upload_location' => NULL,
'#extended' => FALSE,
Dries Buytaert
committed
'#attached' => array(
'css' => array($file_path . '/file.css'),
'js' => array($file_path . '/file.js'),
),
Dries Buytaert
committed
);
Dries Buytaert
committed
return $types;
Dries Buytaert
committed
}
/**
Dries Buytaert
committed
* Implements hook_theme().
Dries Buytaert
committed
*/
function file_theme() {
return array(
// file.module.
'file_link' => array(
'variables' => array('file' => NULL, 'icon_directory' => NULL),
Dries Buytaert
committed
),
'file_icon' => array(
'variables' => array('file' => NULL, 'icon_directory' => NULL),
Dries Buytaert
committed
),
'file_managed_file' => array(
'render element' => 'element',
Dries Buytaert
committed
),
// file.field.inc.
'file_widget' => array(
'render element' => 'element',
Dries Buytaert
committed
),
'file_widget_multiple' => array(
'render element' => 'element',
Dries Buytaert
committed
),
Dries Buytaert
committed
'file_formatter_table' => array(
'variables' => array('items' => NULL),
),
Dries Buytaert
committed
'file_upload_help' => array(
'variables' => array('description' => NULL, 'upload_validators' => NULL),
Dries Buytaert
committed
),
);
}
/**
Dries Buytaert
committed
* Implements hook_file_download().
Angie Byron
committed
*
* This function takes an extra parameter $field_type so that it may
* be re-used by other File-like modules, such as Image.
Dries Buytaert
committed
*/
Angie Byron
committed
function file_file_download($uri, $field_type = 'file') {
Dries Buytaert
committed
global $user;
// Get the file record based on the URI. If not in the database just return.
$files = file_load_multiple(array(), array('uri' => $uri));
if (count($files)) {
foreach ($files as $item) {
// Since some database servers sometimes use a case-insensitive comparison
// by default, double check that the filename is an exact match.
if ($item->uri === $uri) {
$file = $item;
break;
}
}
Dries Buytaert
committed
}
if (!isset($file)) {
Dries Buytaert
committed
return;
}
// Find out which (if any) fields of this type contain the file.
Dries Buytaert
committed
$references = file_get_file_references($file, NULL, FIELD_LOAD_CURRENT, $field_type);
Dries Buytaert
committed
// If there are no references, stop processing, to avoid returning headers
// for files controlled by other modules.
if (empty($references)) {
return;
}
Angie Byron
committed
// Default to allow access.
$denied = FALSE;
// Loop through all references of this file. If a reference explicitly allows
// access to the field to which this file belongs, no further checks are done
// and download access is granted. If a reference denies access, eventually
// existing additional references are checked. If all references were checked
// and no reference denied access, access is granted as well. If at least one
// reference denied access, access is denied.
Dries Buytaert
committed
foreach ($references as $field_name => $field_references) {
foreach ($field_references as $entity_type => $type_references) {
Angie Byron
committed
foreach ($type_references as $id => $reference) {
// Try to load $entity and $field.
$entity = reset(entity_load($entity_type, array($id)));
$field = NULL;
if ($entity) {
// Load all fields for that entity.
$field_items = field_get_items($entity_type, $entity, $field_name);
// Find the field item with the matching URI.
foreach ($field_items as $field_item) {
if ($field_item['uri'] == $uri) {
$field = $field_item;
break;
}
Dries Buytaert
committed
}
}
Angie Byron
committed
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
// Check that $entity and $field were loaded successfully and check if
// access to that field is not disallowed. If any of these checks fail,
// stop checking access for this reference.
if (empty($entity) || empty($field) || !field_access('view', $field, $entity_type, $entity)) {
$denied = TRUE;
break;
}
// Invoke hook and collect grants/denies for download access.
// Default to FALSE and let entities overrule this ruling.
$grants = array('system' => FALSE);
foreach (module_implements('file_download_access') as $module) {
$grants = array_merge($grants, array($module => module_invoke($module, 'file_download_access', $field, $entity_type, $entity)));
}
// Allow other modules to alter the returned grants/denies.
drupal_alter('file_download_access', $grants, $field, $entity_type, $entity);
if (in_array(TRUE, $grants)) {
// If TRUE is returned, access is granted and no further checks are
// necessary.
$denied = FALSE;
break 3;
}
if (in_array(FALSE, $grants)) {
// If an implementation returns FALSE, access to this entity is denied
// but the file could belong to another entity to which the user might
// have access. Continue with these.
$denied = TRUE;
Dries Buytaert
committed
}
}
}
}
Angie Byron
committed
// Access specifically denied.
if ($denied) {
Dries Buytaert
committed
return -1;
}
// Access is granted.
Dries Buytaert
committed
$headers = file_get_content_headers($file);
return $headers;
Dries Buytaert
committed
}
/**
* Menu callback; Shared AJAX callback for file uploads and deletions.
*
* This rebuilds the form element for a particular field item. As long as the
* form processing is properly encapsulated in the widget element the form
* should rebuild correctly using FAPI without the need for additional callbacks
* or processing.
*/
function file_ajax_upload() {
$form_parents = func_get_args();
$form_build_id = (string) array_pop($form_parents);
if (empty($_POST['form_build_id']) || $form_build_id != $_POST['form_build_id']) {
// Invalid request.
drupal_set_message(t('An unrecoverable error occurred. The uploaded file likely exceeded the maximum file size (@size) that this server supports.', array('@size' => format_size(file_upload_max_size()))), 'error');
$commands = array();
$commands[] = ajax_command_replace(NULL, theme('status_messages'));
Angie Byron
committed
return array('#type' => 'ajax', '#commands' => $commands);
Dries Buytaert
committed
}
Dries Buytaert
committed
list($form, $form_state) = ajax_get_form();
Dries Buytaert
committed
if (!$form) {
// Invalid form_build_id.
drupal_set_message(t('An unrecoverable error occurred. Use of this form has expired. Try reloading the page and submitting again.'), 'error');
$commands = array();
$commands[] = ajax_command_replace(NULL, theme('status_messages'));
Angie Byron
committed
return array('#type' => 'ajax', '#commands' => $commands);
Dries Buytaert
committed
}
// Get the current element and count the number of files.
$current_element = $form;
foreach ($form_parents as $parent) {
$current_element = $current_element[$parent];
}
$current_file_count = isset($current_element['#file_upload_delta']) ? $current_element['#file_upload_delta'] : 0;
Dries Buytaert
committed
// Process user input. $form and $form_state are modified in the process.
drupal_process_form($form['#form_id'], $form, $form_state);
Dries Buytaert
committed
// Retrieve the element to be rendered.
foreach ($form_parents as $parent) {
$form = $form[$parent];
}
// Add the special AJAX class if a new file was added.
if (isset($form['#file_upload_delta']) && $current_file_count < $form['#file_upload_delta']) {
$form[$current_file_count]['#attributes']['class'][] = 'ajax-new-content';
}
// Otherwise just add the new content class on a placeholder.
else {
$form['#suffix'] .= '<span class="ajax-new-content"></span>';
}
$output = theme('status_messages') . drupal_render($form);
$js = drupal_add_js();
$settings = call_user_func_array('array_merge_recursive', $js['settings']['data']);
$commands = array();
$commands[] = ajax_command_replace(NULL, $output, $settings);
Angie Byron
committed
return array('#type' => 'ajax', '#commands' => $commands);
Dries Buytaert
committed
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
}
/**
* Menu callback for upload progress.
*
* @param $key
* The unique key for this upload process.
*/
function file_ajax_progress($key) {
$progress = array(
'message' => t('Starting upload...'),
'percentage' => -1,
);
$implementation = file_progress_implementation();
if ($implementation == 'uploadprogress') {
$status = uploadprogress_get_info($key);
if (isset($status['bytes_uploaded']) && !empty($status['bytes_total'])) {
$progress['message'] = t('Uploading... (@current of @total)', array('@current' => format_size($status['bytes_uploaded']), '@total' => format_size($status['bytes_total'])));
$progress['percentage'] = round(100 * $status['bytes_uploaded'] / $status['bytes_total']);
}
}
elseif ($implementation == 'apc') {
$status = apc_fetch('upload_' . $key);
if (isset($status['current']) && !empty($status['total'])) {
$progress['message'] = t('Uploading... (@current of @total)', array('@current' => format_size($status['current']), '@total' => format_size($status['total'])));
$progress['percentage'] = round(100 * $status['current'] / $status['total']);
}
}
Angie Byron
committed
drupal_json_output($progress);
Dries Buytaert
committed
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
}
/**
* Determine the preferred upload progress implementation.
*
* @return
* A string indicating which upload progress system is available. Either "apc"
* or "uploadprogress". If neither are available, returns FALSE.
*/
function file_progress_implementation() {
static $implementation;
if (!isset($implementation)) {
$implementation = FALSE;
// We prefer the PECL extension uploadprogress because it supports multiple
// simultaneous uploads. APC only supports one at a time.
if (extension_loaded('uploadprogress')) {
$implementation = 'uploadprogress';
}
elseif (extension_loaded('apc') && ini_get('apc.rfc1867')) {
$implementation = 'apc';
}
}
return $implementation;
}
/**
Dries Buytaert
committed
* Implements hook_file_delete().
Dries Buytaert
committed
*/
function file_file_delete($file) {
// TODO: Remove references to a file that is in-use.
}
/**
* Process function to expand the managed_file element type.
*
* Expands the file type to include Upload and Remove buttons, as well as
* support for a default value.
*/
function file_managed_file_process($element, &$form_state, $form) {
$fid = isset($element['#value']['fid']) ? $element['#value']['fid'] : 0;
// Set some default element properties.
$element['#progress_indicator'] = empty($element['#progress_indicator']) ? 'none' : $element['#progress_indicator'];
$element['#file'] = $fid ? file_load($fid) : FALSE;
$element['#tree'] = TRUE;
$ajax_settings = array(
'path' => 'file/ajax/' . implode('/', $element['#array_parents']) . '/' . $form['form_build_id']['#value'],
Dries Buytaert
committed
'wrapper' => $element['#id'] . '-ajax-wrapper',
'effect' => 'fade',
'progress' => array(
'type' => $element['#progress_indicator'],
'message' => $element['#progress_message'],
),
);
// Set up the buttons first since we need to check if they were clicked.
$element['upload_button'] = array(
'#name' => implode('_', $element['#parents']) . '_upload_button',
'#type' => 'submit',
'#value' => t('Upload'),
'#validate' => array(),
'#submit' => array('file_managed_file_submit'),
Dries Buytaert
committed
'#limit_validation_errors' => array($element['#parents']),
Dries Buytaert
committed
'#ajax' => $ajax_settings,
'#weight' => -5,
);
$ajax_settings['progress']['type'] ? $ajax_settings['progress']['type'] == 'bar' : 'throbber';
$ajax_settings['progress']['message'] = NULL;
$ajax_settings['effect'] = 'none';
$element['remove_button'] = array(
'#name' => implode('_', $element['#parents']) . '_remove_button',
'#type' => 'submit',
'#value' => t('Remove'),
'#validate' => array(),
'#submit' => array('file_managed_file_submit'),
Dries Buytaert
committed
'#limit_validation_errors' => array($element['#parents']),
Dries Buytaert
committed
'#ajax' => $ajax_settings,
'#weight' => -5,
);
$element['fid'] = array(
'#type' => 'hidden',
'#value' => $fid,
);
// Add progress bar support to the upload if possible.
if ($element['#progress_indicator'] == 'bar' && $implementation = file_progress_implementation()) {
Dries Buytaert
committed
$upload_progress_key = mt_rand();
Dries Buytaert
committed
if ($implementation == 'uploadprogress') {
$element['UPLOAD_IDENTIFIER'] = array(
'#type' => 'hidden',
'#value' => $upload_progress_key,
'#attributes' => array('class' => array('file-progress')),
);
}
elseif ($implementation == 'apc') {
$element['APC_UPLOAD_PROGRESS'] = array(
'#type' => 'hidden',
'#value' => $upload_progress_key,
'#attributes' => array('class' => array('file-progress')),
);
}
// Add the upload progress callback.
$element['upload_button']['#ajax']['progress']['path'] = 'file/progress/' . $upload_progress_key;
}
// The file upload field itself.
$element['upload'] = array(
'#name' => 'files[' . implode('_', $element['#parents']) . ']',
'#type' => 'file',
Dries Buytaert
committed
'#title' => t('Choose a file'),
'#title_display' => 'invisible',
Dries Buytaert
committed
'#size' => 22,
'#theme_wrappers' => array(),
'#weight' => -10,
);
if ($fid && $element['#file']) {
$element['filename'] = array(
'#type' => 'markup',
Dries Buytaert
committed
'#markup' => theme('file_link', array('file' => $element['#file'])) . ' ',
Dries Buytaert
committed
'#weight' => -10,
);
}
Angie Byron
committed
// Add the extension list to the page as JavaScript settings.
Dries Buytaert
committed
if (isset($element['#upload_validators']['file_validate_extensions'][0])) {
Angie Byron
committed
$extension_list = implode(',', array_filter(explode(' ', $element['#upload_validators']['file_validate_extensions'][0])));
$element['upload']['#attached']['js'] = array(
array(
'type' => 'setting',
'data' => array('file' => array('elements' => array('#' . $element['#id'] . '-upload' => $extension_list)))
)
);
Dries Buytaert
committed
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
}
// Prefix and suffix used for AJAX replacement.
$element['#prefix'] = '<div id="' . $element['#id'] . '-ajax-wrapper">';
$element['#suffix'] = '</div>';
return $element;
}
/**
* The #value_callback for a managed_file type element.
*/
function file_managed_file_value(&$element, $input = FALSE, $form_state = NULL) {
$fid = 0;
// Find the current value of this field from the form state.
$form_state_fid = $form_state['values'];
foreach ($element['#parents'] as $parent) {
$form_state_fid = isset($form_state_fid[$parent]) ? $form_state_fid[$parent] : 0;
}
if ($element['#extended'] && isset($form_state_fid['fid'])) {
$fid = $form_state_fid['fid'];
}
elseif (is_numeric($form_state_fid)) {
$fid = $form_state_fid;
}
// Process any input and save new uploads.
if ($input !== FALSE) {
$return = $input;
// Uploads take priority over all other values.
if ($file = file_managed_file_save_upload($element)) {
$fid = $file->fid;
}
else {
// Check for #filefield_value_callback values.
// Because FAPI does not allow multiple #value_callback values like it
// does for #element_validate and #process, this fills the missing
// functionality to allow File fields to be extended through FAPI.
if (isset($element['#file_value_callbacks'])) {
foreach ($element['#file_value_callbacks'] as $callback) {
Angie Byron
committed
$callback($element, $input, $form_state);
Dries Buytaert
committed
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
}
}
// Load file if the FID has changed to confirm it exists.
if (isset($input['fid']) && $file = file_load($input['fid'])) {
$fid = $file->fid;
}
}
}
// If there is no input, set the default value.
else {
if ($element['#extended']) {
$default_fid = isset($element['#default_value']['fid']) ? $element['#default_value']['fid'] : 0;
$return = isset($element['#default_value']) ? $element['#default_value'] : array('fid' => 0);
}
else {
$default_fid = isset($element['#default_value']) ? $element['#default_value'] : 0;
$return = array('fid' => 0);
}
// Confirm that the file exists when used as a default value.
if ($default_fid && $file = file_load($default_fid)) {
$fid = $file->fid;
}
}
$return['fid'] = $fid;
return $return;
}
/**
* An #element_validate callback for the managed_file element.
*/
function file_managed_file_validate(&$element, &$form_state) {
// If referencing an existing file, only allow if there are existing
// references. This prevents unmanaged files from being deleted if this
// item were to be deleted.
$clicked_button = end($form_state['clicked_button']['#parents']);
if ($clicked_button != 'remove_button' && !empty($element['fid']['#value'])) {
if ($file = file_load($element['fid']['#value'])) {
if ($file->status == FILE_STATUS_PERMANENT) {
Dries Buytaert
committed
$references = file_usage_list($file);
if (empty($references)) {
form_error($element, t('The file used in the !name field may not be referenced.', array('!name' => $element['#title'])));
Dries Buytaert
committed
}
}
}
else {
form_error($element, t('The file referenced by the !name field does not exist.', array('!name' => $element['#title'])));
}
}
// Check required property based on the FID.
if ($element['#required'] && empty($element['fid']['#value']) && !in_array($clicked_button, array('upload_button', 'remove_button'))) {
form_error($element['upload'], t('!name field is required.', array('!name' => $element['#title'])));
}
// Consolidate the array value of this field to a single FID.
if (!$element['#extended']) {
form_set_value($element, $element['fid']['#value'], $form_state);
}
}
/**
* Submit handler for upload and remove buttons of managed_file elements.
Dries Buytaert
committed
*/
function file_managed_file_submit($form, &$form_state) {
// Determine whether it was the upload or the remove button that was clicked,
// and set $element to the managed_file element that contains that button.
$parents = $form_state['triggering_element']['#array_parents'];
$button_key = array_pop($parents);
$element = drupal_array_get_nested_value($form, $parents);
// No action is needed here for the upload button, because all file uploads on
// the form are processed by file_managed_file_value() regardless of which
// button was clicked. Action is needed here for the remove button, because we
// only remove a file in response to its remove button being clicked.
if ($button_key == 'remove_button') {
// If it's a temporary file we can safely remove it immediately, otherwise
// it's up to the implementing module to clean up files that are in use.
if ($element['#file'] && $element['#file']->status == 0) {
file_delete($element['#file']);
}
// Update both $form_state['values'] and $form_state['input'] to reflect
// that the file has been removed, so that the form is rebuilt correctly.
// $form_state['values'] must be updated in case additional submit handlers
// run, and for form building functions that run during the rebuild, such as
// when the managed_file element is part of a field widget.
// $form_state['input'] must be updated so that file_managed_file_value()
// has correct information during the rebuild.
$values_element = $element['#extended'] ? $element['fid'] : $element;
form_set_value($values_element, NULL, $form_state);
drupal_array_set_nested_value($form_state['input'], $values_element['#parents'], NULL);
}
// Set the form to rebuild so that $form is correctly updated in response to
// processing the file removal. Since this function did not change $form_state
// if the upload button was clicked, a rebuild isn't necessary in that
// situation and setting $form_state['redirect'] to FALSE would suffice.
// However, we choose to always rebuild, to keep the form processing workflow
// consistent between the two buttons.
$form_state['rebuild'] = TRUE;
Dries Buytaert
committed
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
}
/**
* Given a managed_file element, save any files that have been uploaded into it.
*
* @param $element
* The FAPI element whose values are being saved.
* @return
* The file object representing the file that was saved, or FALSE if no file
* was saved.
*/
function file_managed_file_save_upload($element) {
$upload_name = implode('_', $element['#parents']);
if (empty($_FILES['files']['name'][$upload_name])) {
return FALSE;
}
$destination = isset($element['#upload_location']) ? $element['#upload_location'] : NULL;
if (isset($destination) && !file_prepare_directory($destination, FILE_CREATE_DIRECTORY)) {
watchdog('file', 'The upload directory %directory for the file field !name 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' => $destination, '!name' => $element['#field_name']));
form_set_error($upload_name, t('The file could not be uploaded.'));
return FALSE;
}
if (!$file = file_save_upload($upload_name, $element['#upload_validators'], $destination)) {
watchdog('file', 'The file upload failed. %upload', array('%upload' => $upload_name));
form_set_error($upload_name, t('The file in the !name field was unable to be uploaded.', array('!name' => $element['#title'])));
return FALSE;
}
return $file;
}
/**
* Returns HTML for a managed file element.
*
* @param $variables
* An associative array containing:
* - element: A render element representing the file.
*
* @ingroup themeable
Dries Buytaert
committed
*/
Dries Buytaert
committed
function theme_file_managed_file($variables) {
$element = $variables['element'];
Dries Buytaert
committed
// This wrapper is required to apply JS behaviors and CSS styling.
$output = '';
$output .= '<div class="form-managed-file">';
$output .= drupal_render_children($element);
$output .= '</div>';
return $output;
}
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
/**
* #pre_render callback to hide display of the upload or remove controls.
*
* Upload controls are hidden when a file is already uploaded. Remove controls
* are hidden when there is no file attached. Controls are hidden here instead
* of in file_managed_file_process(), because #access for these buttons depends
* on the managed_file element's #value. See the documentation of form_builder()
* for more detailed information about the relationship between #process,
* #value, and #access.
*
* Because #access is set here, it affects display only and does not prevent
* JavaScript or other untrusted code from submitting the form as though access
* were enabled. The form processing functions for these elements should not
* assume that the buttons can't be "clicked" just because they are not
* displayed.
*
* @see file_managed_file_process()
* @see form_builder()
*/
function file_managed_file_pre_render($element) {
// If we already have a file, we don't want to show the upload controls.
if (!empty($element['#value']['fid'])) {
$element['upload']['#access'] = FALSE;
$element['upload_button']['#access'] = FALSE;
}
// If we don't already have a file, there is nothing to remove.
else {
$element['remove_button']['#access'] = FALSE;
}
return $element;
}
Dries Buytaert
committed
/**
* Returns HTML for a link to a file.
Dries Buytaert
committed
*
Dries Buytaert
committed
* @param $variables
* An associative array containing:
* - file: A file object to which the link will be created.
* - icon_directory: (optional) A path to a directory of icons to be used for
* files. Defaults to the value of the "file_icon_directory" variable.
*
* @ingroup themeable
Dries Buytaert
committed
*/
Dries Buytaert
committed
function theme_file_link($variables) {
$file = $variables['file'];
$icon_directory = $variables['icon_directory'];
Dries Buytaert
committed
Dries Buytaert
committed
$url = file_create_url($file->uri);
$icon = theme('file_icon', array('file' => $file, 'icon_directory' => $icon_directory));
Dries Buytaert
committed
// Set options as per anchor format described at
// http://microformats.org/wiki/file-format-examples
$options = array(
'attributes' => array(
'type' => $file->filemime . '; length=' . $file->filesize,
),
);
// Use the description as the link text if available.
Angie Byron
committed
if (empty($file->description)) {
Dries Buytaert
committed
$link_text = $file->filename;
Dries Buytaert
committed
}
else {
Dries Buytaert
committed
$link_text = $file->description;
Dries Buytaert
committed
$options['attributes']['title'] = check_plain($file->filename);
}
return '<span class="file">' . $icon . ' ' . l($link_text, $url, $options) . '</span>';
}
/**
* Returns HTML for an image with an appropriate icon for the given file.
Dries Buytaert
committed
*
Dries Buytaert
committed
* @param $variables
* An associative array containing:
* - file: A file object for which to make an icon.
* - icon_directory: (optional) A path to a directory of icons to be used for
* files. Defaults to the value of the "file_icon_directory" variable.
*
* @ingroup themeable
Dries Buytaert
committed
*/
Dries Buytaert
committed
function theme_file_icon($variables) {
$file = $variables['file'];
$icon_directory = $variables['icon_directory'];
Dries Buytaert
committed
Dries Buytaert
committed
$mime = check_plain($file->filemime);
$icon_url = file_icon_url($file, $icon_directory);
Dries Buytaert
committed
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
return '<img class="file-icon" alt="" title="' . $mime . '" src="' . $icon_url . '" />';
}
/**
* Given a file object, create a URL to a matching icon.
*
* @param $file
* A file object.
* @param $icon_directory
* (optional) A path to a directory of icons to be used for files. Defaults to
* the value of the "file_icon_directory" variable.
* @return
* A URL string to the icon, or FALSE if an appropriate icon cannot be found.
*/
function file_icon_url($file, $icon_directory = NULL) {
if ($icon_path = file_icon_path($file, $icon_directory)) {
return base_path() . $icon_path;
}
return FALSE;
}
/**
* Given a file object, create a path to a matching icon.
*
* @param $file
* A file object.
* @param $icon_directory
* (optional) A path to a directory of icons to be used for files. Defaults to
* the value of the "file_icon_directory" variable.
* @return
* A string to the icon as a local path, or FALSE if an appropriate icon could
* not be found.
*/
function file_icon_path($file, $icon_directory = NULL) {
// Use the default set of icons if none specified.
if (!isset($icon_directory)) {
$icon_directory = variable_get('file_icon_directory', drupal_get_path('module', 'file') . '/icons');
}
// If there's an icon matching the exact mimetype, go for it.
$dashed_mime = strtr($file->filemime, array('/' => '-'));
$icon_path = $icon_directory . '/' . $dashed_mime . '.png';
if (file_exists($icon_path)) {
return $icon_path;
}
// For a few mimetypes, we can "manually" map to a generic icon.
$generic_mime = (string) file_icon_map($file);
$icon_path = $icon_directory . '/' . $generic_mime . '.png';
if ($generic_mime && file_exists($icon_path)) {
return $icon_path;
}
// Use generic icons for each category that provides such icons.
foreach (array('audio', 'image', 'text', 'video') as $category) {
if (strpos($file->filemime, $category . '/') === 0) {
$icon_path = $icon_directory . '/' . $category . '-x-generic.png';
if (file_exists($icon_path)) {
return $icon_path;
}
}
}
// Try application-octet-stream as last fallback.
$icon_path = $icon_directory . '/application-octet-stream.png';
if (file_exists($icon_path)) {
return $icon_path;
}
// No icon can be found.
return FALSE;
}
/**
* Determine the generic icon MIME package based on a file's MIME type.
*
* @param $file
* A file object.
* @return
* The generic icon MIME package expected for this file.
*/
function file_icon_map($file) {
switch ($file->filemime) {
// Word document types.
case 'application/msword':
case 'application/vnd.ms-word.document.macroEnabled.12':
case 'application/vnd.oasis.opendocument.text':
case 'application/vnd.oasis.opendocument.text-template':
case 'application/vnd.oasis.opendocument.text-master':
case 'application/vnd.oasis.opendocument.text-web':
case 'application/vnd.openxmlformats-officedocument.wordprocessingml.document':
case 'application/vnd.stardivision.writer':
case 'application/vnd.sun.xml.writer':
case 'application/vnd.sun.xml.writer.template':
case 'application/vnd.sun.xml.writer.global':
case 'application/vnd.wordperfect':
case 'application/x-abiword':
case 'application/x-applix-word':
case 'application/x-kword':
case 'application/x-kword-crypt':
return 'x-office-document';
// Spreadsheet document types.
case 'application/vnd.ms-excel':
case 'application/vnd.ms-excel.sheet.macroEnabled.12':
case 'application/vnd.oasis.opendocument.spreadsheet':
case 'application/vnd.oasis.opendocument.spreadsheet-template':
case 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
case 'application/vnd.stardivision.calc':
case 'application/vnd.sun.xml.calc':
case 'application/vnd.sun.xml.calc.template':
case 'application/vnd.lotus-1-2-3':
case 'application/x-applix-spreadsheet':
case 'application/x-gnumeric':
case 'application/x-kspread':
case 'application/x-kspread-crypt':
return 'x-office-spreadsheet';
// Presentation document types.
case 'application/vnd.ms-powerpoint':
case 'application/vnd.ms-powerpoint.presentation.macroEnabled.12':
case 'application/vnd.oasis.opendocument.presentation':
case 'application/vnd.oasis.opendocument.presentation-template':
case 'application/vnd.openxmlformats-officedocument.presentationml.presentation':
case 'application/vnd.stardivision.impress':
case 'application/vnd.sun.xml.impress':
case 'application/vnd.sun.xml.impress.template':
case 'application/x-kpresenter':
return 'x-office-presentation';
// Compressed archive types.
case 'application/zip':
case 'application/x-zip':
case 'application/stuffit':
case 'application/x-stuffit':
case 'application/x-7z-compressed':
case 'application/x-ace':
case 'application/x-arj':
case 'application/x-bzip':
case 'application/x-bzip-compressed-tar':
case 'application/x-compress':
case 'application/x-compressed-tar':
case 'application/x-cpio-compressed':
case 'application/x-deb':
case 'application/x-gzip':
case 'application/x-java-archive':
case 'application/x-lha':
case 'application/x-lhz':
case 'application/x-lzop':
case 'application/x-rar':
case 'application/x-rpm':
case 'application/x-tzo':
case 'application/x-tar':
case 'application/x-tarz':
case 'application/x-tgz':
return 'package-x-generic';
// Script file types.
case 'application/ecmascript':
case 'application/javascript':
case 'application/mathematica':
case 'application/vnd.mozilla.xul+xml':
case 'application/x-asp':
case 'application/x-awk':
case 'application/x-cgi':
case 'application/x-csh':
case 'application/x-m4':
case 'application/x-perl':
case 'application/x-php':
case 'application/x-ruby':
case 'application/x-shellscript':
case 'text/vnd.wap.wmlscript':
case 'text/x-emacs-lisp':
case 'text/x-haskell':
case 'text/x-literate-haskell':
case 'text/x-lua':
case 'text/x-makefile':
case 'text/x-matlab':
case 'text/x-python':
case 'text/x-sql':
case 'text/x-tcl':
return 'text-x-script';
// HTML aliases.
case 'application/xhtml+xml':
return 'text-html';
// Executable types.
case 'application/x-macbinary':
case 'application/x-ms-dos-executable':
case 'application/x-pef-executable':
return 'application-x-executable';
default:
return FALSE;
}
}
/**
* @defgroup file-module-api File module public API functions
* @{
* These functions may be used to determine if and where a file is in use.
*/
/**
Dries Buytaert
committed
* Gets a list of references to a file.
Dries Buytaert
committed
*
* @param $file
* A file object.
* @param $field
Angie Byron
committed
* (optional) A field array to be used for this check. If given, limits the
* reference check to the given field.
Dries Buytaert
committed
* @param $age
* (optional) A constant that specifies which references to count. Use
* FIELD_LOAD_REVISION to retrieve all references within all revisions or
* FIELD_LOAD_CURRENT to retrieve references only in the current revisions.
Angie Byron
committed
* @param $field_type
Dries Buytaert
committed
* (optional) The name of a field type. If given, limits the reference check
* to fields of the given type.
*
Dries Buytaert
committed
* @return
* An integer value.
*/
Angie Byron
committed
function file_get_file_references($file, $field = NULL, $age = FIELD_LOAD_REVISION, $field_type = 'file') {
Dries Buytaert
committed
$references = drupal_static(__FUNCTION__, array());
$fields = isset($field) ? array($field['field_name'] => $field) : field_info_fields();
Dries Buytaert
committed
foreach ($fields as $field_name => $file_field) {
Dries Buytaert
committed
if ((empty($field_type) || $file_field['type'] == $field_type) && !isset($references[$field_name])) {
Dries Buytaert
committed
// Get each time this file is used within a field.
Dries Buytaert
committed
$query = new EntityFieldQuery();
$query
->fieldCondition($file_field, 'fid', $file->fid)
->age($age);
$references[$field_name] = $query->execute();