Project

General

Profile

Paste
Download (9.87 KB) Statistics
| Branch: | Revision:

root / drupal7 / sites / all / modules / file_entity / file_entity.file.inc @ 1f142f4f

1
<?php
2

    
3
/**
4
 * @file
5
 * File hooks implemented by the File entity module.
6
 */
7

    
8
/**
9
 * Implements hook_file_presave().
10
 */
11
function file_entity_file_presave($file) {
12
  // Always ensure the filemime property is current.
13
  if (!empty($file->original) || empty($file->filemime)) {
14
    $file->filemime = file_get_mimetype($file->uri);
15
  }
16

    
17
  // The file type is used as a bundle key, and therefore, must not be NULL.
18
  // It defaults to FILE_TYPE_NONE when loaded via file_load(), but in case
19
  // file_save() is called on a new file object, default it here too.
20
  if (!isset($file->type)) {
21
    $file->type = FILE_TYPE_NONE;
22
  }
23

    
24
  // If the file isn't already assigned a real type, determine what type should
25
  // be assigned to it.
26
  if ($file->type === FILE_TYPE_NONE) {
27
    $type = file_get_type($file);
28
    if (isset($type)) {
29
      $file->type = $type;
30
    }
31
  }
32

    
33
  field_attach_presave('file', $file);
34

    
35
  // Fetch image dimensions.
36
  file_entity_metadata_fetch_image_dimensions($file);
37
}
38

    
39
/**
40
 * Implements hook_file_type().
41
 */
42
function file_entity_file_type($file) {
43
  $types = array();
44
  foreach (file_type_get_enabled_types() as $type) {
45
    if (file_entity_match_mimetypes($type->mimetypes, $file->filemime)) {
46
      $types[] = $type->type;
47
    }
48
  }
49

    
50
  return $types;
51
}
52

    
53
/**
54
 * Implements hook_file_insert().
55
 */
56
function file_entity_file_insert($file) {
57
  // Ensure field data is saved since file_save() does not in Drupal 7.
58
  field_attach_insert('file', $file);
59

    
60
  // Save file metadata.
61
  if (!empty($file->metadata)) {
62
    $query = db_insert('file_metadata')->fields(array('fid', 'name', 'value'));
63
    foreach ($file->metadata as $name => $value) {
64
      $query->values(array(
65
        'fid' => $file->fid,
66
        'name' => $name,
67
        'value' => serialize($value),
68
      ));
69
    }
70
    $query->execute();
71
  }
72

    
73
  // Clear any related field caches.
74
  file_entity_invalidate_field_caches($file);
75
}
76

    
77
/**
78
 * Implements hook_file_update().
79
 */
80
function file_entity_file_update($file) {
81
  // Ensure field data is saved since file_save() does not in Drupal 7.
82
  field_attach_update('file', $file);
83

    
84
  // Save file metadata.
85
  db_delete('file_metadata')->condition('fid', $file->fid)->execute();
86
  if (!empty($file->metadata)) {
87
    $query = db_insert('file_metadata')->fields(array('fid', 'name', 'value'));
88
    foreach ($file->metadata as $name => $value) {
89
      $query->values(array(
90
        'fid' => $file->fid,
91
        'name' => $name,
92
        'value' => serialize($value),
93
      ));
94
    }
95
    $query->execute();
96
  }
97

    
98
  if (module_exists('image') && file_entity_file_get_mimetype_type($file) == 'image' && $file->filesize) {
99
    // If the file has changed dimensions or a new file has been uploaded,
100
    // update any image field reference to this file and flush image style
101
    // derivatives.
102
    $file->metadata += array('width' => NULL, 'height' => NULL);
103
    $file->original->metadata += array('width' => NULL, 'height' => NULL);
104
    if ($file->filesize != $file->original->filesize || $file->metadata['width'] != $file->original->metadata['width'] || $file->metadata['height'] != $file->original->metadata['height']) {
105
      _file_entity_update_image_field_dimensions($file);
106
    }
107

    
108
    // Flush image style derivatives whenever an image is updated.
109
    image_path_flush($file->uri);
110
  }
111

    
112
  // Clear any related field caches.
113
  file_entity_invalidate_field_caches($file);
114
}
115

    
116
/**
117
 * Implements hook_file_delete().
118
 */
119
function file_entity_file_delete($file) {
120
  field_attach_delete('file', $file);
121

    
122
  // This is safe to call since the file's records from the usage table have
123
  // not yet been deleted.
124
  file_entity_invalidate_field_caches($file);
125

    
126
  // Remove file metadata.
127
  db_delete('file_metadata')->condition('fid', $file->fid)->execute();
128

    
129
  // Remove this file from the search index if needed.
130
  // This code is implemented in file entity module rather than in search
131
  // module because file entity is implementing search module's API, not the
132
  // other way around.
133
  if (module_exists('search')) {
134
    search_reindex($file->fid, 'file');
135
  }
136
}
137

    
138
/**
139
 * Implements hook_file_mimetype_mapping_alter().
140
 */
141
function file_entity_file_mimetype_mapping_alter(&$mapping) {
142
  // Add support for mka and mkv.
143
  // @todo Remove when http://drupal.org/node/1443070 is fixed in core.
144
  $new_mappings['mka'] = 'audio/x-matroska';
145
  $new_mappings['mkv'] = 'video/x-matroska';
146

    
147
  // Add support for weba, webm, and webp.
148
  // @todo Remove when http://drupal.org/node/1443070 is fixed in core.
149
  $new_mappings['weba'] = 'audio/webm';
150
  $new_mappings['webm'] = 'video/webm';
151
  $new_mappings['webp'] = 'image/webp';
152

    
153
  foreach ($new_mappings as $extension => $mime_type) {
154
    if (!in_array($mime_type, $mapping['mimetypes'])) {
155
      // If the mime type does not already exist, add it.
156
      $mapping['mimetypes'][] = $mime_type;
157
    }
158

    
159
    // Get the index of the mime type and assign the extension to that key.
160
    $index = array_search($mime_type, $mapping['mimetypes']);
161
    $mapping['extensions'][$extension] = $index;
162
  }
163
}
164

    
165
/**
166
 * Implements hook_file_load().
167
 */
168
function file_entity_file_load($files) {
169
  // Add alt and title text to images.
170
  $alt = variable_get('file_entity_alt', '[file:field_file_image_alt_text]');
171
  $title = variable_get('file_entity_title', '[file:field_file_image_title_text]');
172

    
173
  $replace_options = array(
174
    'clear' => TRUE,
175
    'sanitize' => FALSE,
176
  );
177

    
178
  foreach ($files as $file) {
179
    $file->metadata = array();
180

    
181
    // Load alt and title text from fields.
182
    if (!empty($alt)) {
183
      $output = token_replace($alt, array('file' => $file), $replace_options);
184

    
185
      // @todo Remove once https://www.drupal.org/node/1713164 is fixed.
186
      // There is currently no way to get the raw alt text returned from the
187
      // token so we revert the encoding done during tokenization.
188
      $file->alt = decode_entities($output);
189
    }
190
    if (!empty($title)) {
191
      $output = token_replace($title, array('file' => $file), $replace_options);
192

    
193
      // @todo Remove once https://www.drupal.org/node/1713164 is fixed.
194
      // There is currently no way to get the raw title text returned from the
195
      // token so we revert the encoding done during tokenization.
196
      $file->title = decode_entities($output);
197
    }
198
  }
199

    
200
  // Load and unserialize metadata.
201
  $results = db_query("SELECT * FROM {file_metadata} WHERE fid IN (:fids)", array(':fids' => array_keys($files)));
202

    
203
  foreach ($results as $result) {
204
    $name = $result->name;
205

    
206
    // image.module required height and width to be properties of the file.
207
    if ($name == 'height' || $name == 'width') {
208
      $files[$result->fid]->$name = unserialize($result->value);
209
    }
210

    
211
    $files[$result->fid]->metadata[$name] = unserialize($result->value);
212
  }
213
}
214

    
215
/**
216
 * Fetch the dimensions of an image and store them in the file metadata array.
217
 */
218
function file_entity_metadata_fetch_image_dimensions($file) {
219
  // Prevent PHP notices when trying to read empty files.
220
  // @see http://drupal.org/node/681042
221
  if (!$file->filesize) {
222
    return;
223
  }
224

    
225
  // Do not bother proceeding if this file does not have an image mime type.
226
  if (file_entity_file_get_mimetype_type($file) != 'image') {
227
    return;
228
  }
229

    
230
  // We have a non-empty image file.
231
  $image_info = image_get_info($file->uri);
232
  if ($image_info) {
233
    $file->metadata['width'] = $image_info['width'];
234
    $file->metadata['height'] = $image_info['height'];
235
  }
236
  else {
237
    // Fallback to NULL values.
238
    $file->metadata['width'] = NULL;
239
    $file->metadata['height'] = NULL;
240
  }
241
}
242

    
243
/**
244
 * Update the image dimensions stored in any image fields for a file.
245
 *
246
 * @param object $file
247
 *   A file object that is an image.
248
 *
249
 * @see http://drupal.org/node/1448124
250
 */
251
function _file_entity_update_image_field_dimensions($file) {
252
  // Prevent PHP notices when trying to read empty files.
253
  // @see http://drupal.org/node/681042
254
  if (!$file->filesize) {
255
    return;
256
  }
257

    
258
  // Do not bother proceeding if this file does not have an image mime type.
259
  if (file_entity_file_get_mimetype_type($file) != 'image') {
260
    return;
261
  }
262

    
263
  // Find all image field enabled on the site.
264
  $image_fields = _file_entity_get_fields_by_type('image');
265

    
266
  foreach ($image_fields as $image_field) {
267
    $query = new EntityFieldQuery();
268
    $query->fieldCondition($image_field, 'fid', $file->fid);
269
    $results = $query->execute();
270

    
271
    foreach ($results as $entity_type => $entities) {
272
      $entities = entity_load($entity_type, array_keys($entities));
273
      foreach ($entities as $entity) {
274
        foreach ($entity->{$image_field} as $langcode => $items) {
275
          foreach ($items as $delta => $item) {
276
            if ($item['fid'] == $file->fid) {
277
              $entity->{$image_field}[$langcode][$delta]['width'] = $file->metadata['width'];
278
              $entity->{$image_field}[$langcode][$delta]['height'] = $file->metadata['height'];
279
            }
280
          }
281
        }
282

    
283
        // Save the updated field column values.
284
        _file_entity_entity_fields_update($entity_type, $entity);
285
      }
286
    }
287
  }
288
}
289

    
290
/**
291
 * Update an entity's field values without changing anything on the entity.
292
 */
293
function _file_entity_entity_fields_update($entity_type, $entity) {
294
  list($id) = entity_extract_ids($entity_type, $entity);
295
  if (empty($id)) {
296
    throw new Exception(t('Cannot call _file_entity_update_entity_fields() on a new entity.'));
297
  }
298

    
299
  // Some modules use the original property.
300
  if (!isset($entity->original)) {
301
    $entity->original = $entity;
302
  }
303

    
304
  // Ensure that file_field_update() will not trigger additional usage.
305
  unset($entity->revision);
306

    
307
  // Invoke the field presave and update hooks.
308
  field_attach_presave($entity_type, $entity);
309
  field_attach_update($entity_type, $entity);
310

    
311
  // Clear the cache for this entity now.
312
  entity_get_controller($entity_type)->resetCache(array($id));
313
}
314

    
315
/**
316
 * Implements hook_file_metadata_info().
317
 */
318
function file_entity_file_metadata_info() {
319
  $info['width'] = array('label' => t('Width'), 'type' => 'integer');
320
  $info['height'] = array('label' => t('Height'), 'type' => 'integer');
321
  return $info;
322
}