Mercurial > defr > drupal > scald > mee

annotate mee.module @ 6:2ef0d9a3eeba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Syntax error fix
author Franck Deroche <franck@defr.org>
date Tue, 28 Apr 2009 10:19:16 +0200
parents 5df98f90134d
children c3b22723b82f
rev   line source
eads@0 1 <?php
eads@0 2 // $Id;
eads@0 3 /**
eads@0 4 * @file
eads@0 5 * Defines a special textarea, with drag and drop media driven by Scald and
eads@0 6 * dnd.module when rich text editing is enabled on the textarea via the
eads@0 7 * WYSIWYG API.
eads@0 8 */
eads@0 9
eads@0 10 /**
eads@0 11 * Implementation of hook_theme().
eads@0 12 */
eads@0 13 function mee_theme() {
eads@0 14 $theme = array(
eads@0 15 'mee_textarea' => array(
eads@0 16 'arguments' => array('element' => NULL),
eads@0 17 ),
eads@0 18 'mee_formatter_default' => array(
eads@0 19 'arguments' => array('element' => NULL),
eads@0 20 ),
eads@0 21 );
tom@2 22
tom@2 23 $scald_config = variable_get('scald_config', 0);
tom@2 24 foreach ($scald_config->contexts as $context => $details) {
tom@2 25 $theme['mee_formatter_'. $context] = array(
tom@2 26 'arguments' => array('element' => NULL),
tom@2 27 'function' => 'theme_mee_context_formatter',
tom@2 28 );
tom@2 29 }
eads@0 30 return $theme;
eads@0 31 }
eads@0 32
eads@0 33 /**
eads@0 34 * Implementation of hook_field_info().
eads@0 35 */
eads@0 36 function mee_field_info() {
eads@0 37 return array(
eads@0 38 'multimedia_editorial_element' => array(
eads@0 39 'label' => t('Multimedia Editorial Element (MEE)'),
eads@0 40 'description' => t('MEE combines Scald, WYSIWYG, and DnD to create a multimedia enabled text field.'),
eads@0 41 ),
eads@0 42 );
eads@0 43 }
eads@0 44
eads@0 45 /**
eads@0 46 * Implementation of hook_field_settings().
eads@0 47 */
eads@0 48 function mee_field_settings($op, $field) {
eads@0 49 switch ($op) {
eads@0 50 case 'form':
eads@0 51 $form = array();
eads@0 52 $options = array(0 => t('Plain text'), 1 => t('Filtered text (user selects input format)'));
tom@5 53
tom@5 54 $scald_config = variable_get('scald_config', 0);
tom@5 55 $context_options = array();
tom@5 56 $contexts_result = db_query("SELECT context, title FROM {scald_contexts} WHERE context IN ('" . implode("', '", array_keys($scald_config->contexts)) . "') ORDER BY title");
tom@5 57 while ($context_raw = db_fetch_array($contexts_result)) {
tom@5 58 $context_options[$context_raw['context']] = $context_raw['title'];
tom@5 59 }
tom@5 60
eads@0 61 $form['mee_processing'] = array(
eads@0 62 '#type' => 'radios',
eads@0 63 '#title' => t('Text processing'),
eads@0 64 '#default_value' => is_numeric($field['mee_processing']) ? $field['mee_processing'] : 1,
eads@0 65 '#options' => $options,
eads@0 66 '#description' => t('Filtered text, with a WYSIWYG editor defined on one or more input formats, is strongly recommended.'),
eads@0 67 );
eads@0 68 // @TODO Ask Drupal about available libraries
eads@0 69 $form['mee_dnd_callback_url'] = array(
eads@0 70 '#type' => 'textfield',
eads@0 71 '#title' => t('Library callback URL'),
eads@0 72 '#default_value' => url($field['mee_dnd_callback_url']) ? $field['mee_dnd_callback_url'] : '',
eads@0 73 '#description' => t('The absolute URL or relative path of a callback URL that provides proper JSON to the drag and drop library.'),
eads@0 74 );
tom@5 75 $form['mee_scald_editor_context'] = array(
tom@5 76 '#type' => 'select',
tom@5 77 '#title' => t('Scald Editor Context'),
tom@5 78 '#description' => t('Choose a Scald Context to use for displaying Scald Atoms included in the textarea during editing.'),
tom@5 79 '#default_value' => $field['mee_scald_editor_context'],
tom@5 80 '#options' => $context_options,
tom@5 81 );
eads@0 82 return $form;
eads@0 83
eads@0 84 case 'save':
tom@4 85 return array('mee_processing', 'mee_dnd_callback_url', 'mee_scald_editor_context');
eads@0 86
eads@0 87 case 'database columns':
eads@0 88 $columns['value'] = array('type' => 'text', 'size' => 'big', 'not null' => FALSE, 'sortable' => TRUE);
eads@0 89 $columns['dnd_callback_url'] = array('type' => 'text', 'size' => 'small', 'not null' => FALSE);
eads@0 90 if (!empty($field['mee_processing'])) {
eads@0 91 $columns['format'] = array('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE);
eads@0 92 }
tom@5 93 $columns['mee_scald_editor_context'] = array('type' => 'text', 'size' => 'small', 'not null' => FALSE);
eads@0 94 return $columns;
eads@0 95
eads@0 96 case 'views data':
eads@0 97 return content_views_field_views_data($field);
eads@0 98 }
eads@0 99 }
eads@0 100
eads@0 101 /**
eads@0 102 * Implementation of hook_field().
eads@0 103 */
eads@0 104 function mee_field($op, &$node, $field, &$items, $teaser, $page) {
eads@0 105 switch ($op) {
tom@2 106 case 'presave':
tom@5 107 foreach ($items as $delta => &$item) {
tom@5 108 if (!empty($item['value'])) {
tom@5 109 $item['value'] = scald_rendered_to_sas($item['value']);
tom@5 110 }
tom@5 111 }
tom@2 112 break; // end 'submit'
tom@2 113
tom@2 114 case 'insert':
tom@2 115 foreach ($items as $delta => $item) {
tom@5 116 $scald_included = scald_included($item['value']);
tom@3 117
tom@3 118 $temp_atom = new stdClass;
tom@3 119 $temp_atom->type = 'composite';
tom@3 120 $temp_atom->provider = 'mee';
tom@3 121 $temp_atom->base_id = $node->nid . ':' . $delta;
tom@3 122 $temp_atom->publisher = $node->uid;
tom@5 123 $temp_atom->title = $node->title . ' - ' . $field['widget']['label'] . ' (#' . $delta . ')';
tom@3 124 $temp_atom->authors = array(scald_uid_to_aid($node->uid));
tom@2 125 $temp_atom->relationships = empty($scald_included) ? array() : array('includes' => $scald_included);
tom@3 126
tom@2 127 $sid = scald_register_atom($temp_atom);
tom@2 128 }
tom@2 129 break; // end 'insert'
tom@2 130
tom@2 131 case 'update':
tom@2 132 foreach ($items as $delta => $item) {
tom@5 133 $scald_included = scald_included($item['value']);
tom@2 134
tom@3 135 // @@@TODO: Handle failure of fetch
tom@3 136 $atom = scald_fetch(scald_search(array('base_id' => $node->nid . ':' . $delta), FALSE, TRUE));
tom@3 137 $atom->publisher = $node->uid;
franck@6 138 $atom->title = $node->title;
tom@5 139 $atom->authors = array(scald_uid_to_aid($node->uid)); // @@@TODO: This will completely override any authors listed & replace only with the Publisher.
franck@6 140 $atom->relationships = empty($scald_included) ? array() : array('includes' => $scald_included);
tom@3 141
tom@3 142 scald_update_atom($atom);
tom@2 143 }
tom@2 144 break; // end 'update'
tom@2 145
tom@2 146 case 'delete':
tom@3 147 foreach ($items as $delta => $item) {
tom@3 148 scald_unregister_atom(scald_search(array('base_id' => $node->nid . ':' . $delta), FALSE, TRUE));
tom@3 149 }
tom@2 150 break; // end 'delete'
tom@2 151
eads@0 152 case 'sanitize':
eads@0 153 foreach ($items as $delta => $item) {
eads@0 154 if (!empty($field['mee_processing'])) {
eads@0 155 $check = is_null($node) || (isset($node->build_mode) && $node->build_mode == NODE_BUILD_PREVIEW);
eads@0 156 $text = isset($item['value']) ? check_markup($item['value'], $item['format'], $check) : '';
eads@0 157 }
eads@0 158 else {
eads@0 159 $text = check_plain($item['value']);
eads@0 160 }
eads@0 161 $items[$delta]['safe'] = $text;
eads@0 162 }
tom@2 163 break; // end 'sanitize'
eads@0 164 }
eads@0 165 }
eads@0 166
eads@0 167 /**
eads@0 168 * Implementation of hook_content_is_empty().
eads@0 169 */
eads@0 170 function mee_content_is_empty($item, $field) {
eads@0 171 if (empty($item['value']) && (string)$item['value'] !== '0') {
eads@0 172 return TRUE;
eads@0 173 }
eads@0 174 return FALSE;
eads@0 175 }
eads@0 176
eads@0 177 /**
eads@0 178 * Implementation of hook_field_formatter_info().
eads@0 179 */
eads@0 180 function mee_field_formatter_info() {
eads@0 181 $formatters = array(
eads@0 182 'default' => array(
eads@0 183 'label' => t('Filtered text'),
eads@0 184 'field types' => array('multimedia_editorial_element'),
eads@0 185 'multiple values' => CONTENT_HANDLE_CORE,
eads@0 186 ),
eads@0 187 'plain' => array(
eads@0 188 'label' => t('Plain text'),
eads@0 189 'field types' => array('multimedia_editorial_element'),
eads@0 190 'multiple values' => CONTENT_HANDLE_CORE,
eads@0 191 ),
eads@0 192 );
eads@0 193 //@TODO generate context processor based field formatters
eads@0 194 //foreach (scald_contexts() as $context) {
eads@0 195 // $formatters[$context] = array(
eads@0 196 // 'label' => t('Scald context processor: @context', array('@context' => $context),
eads@0 197 // 'field types' => 'mee',
eads@0 198 // );
eads@0 199 //}
eads@0 200 return $formatters;
eads@0 201 }
eads@0 202
eads@0 203 function theme_mee_formatter_default($element) {
tom@4 204 return scald_sas_to_rendered($element['#item']['safe']);
eads@0 205 }
eads@0 206
eads@0 207 /**
eads@0 208 * Theme function for 'plain' text field formatter.
eads@0 209 */
eads@0 210 function theme_mee_formatter_plain($element) {
tom@4 211 return strip_tags(scald_sas_to_rendered($element['#item']['safe'], 'title', TRUE));
eads@0 212 }
eads@0 213
tom@4 214 //function theme_mee_context_formatter($element) {
tom@4 215 // return 'foo';
tom@4 216 //}
eads@0 217
eads@0 218 /**
eads@0 219 * Implementation of hook_widget_info().
eads@0 220 */
eads@0 221 function mee_widget_info() {
eads@0 222 return array(
eads@0 223 'mee_textarea' => array(
eads@0 224 'label' => t('MEE Textarea'),
eads@0 225 'field types' => array('multimedia_editorial_element'),
eads@0 226 'multiple values' => CONTENT_HANDLE_CORE,
eads@0 227 ),
eads@0 228 );
eads@0 229 }
eads@0 230
eads@0 231 /**
eads@0 232 * Implementation of FAPI hook_elements().
eads@0 233 *
eads@0 234 * Any FAPI callbacks needed for individual widgets can be declared here,
eads@0 235 * and the element will be passed to those callbacks for processing.
eads@0 236 *
eads@0 237 * Drupal will automatically theme the element using a theme with
eads@0 238 * the same name as the hook_elements key.
eads@0 239 */
eads@0 240 function mee_elements() {
eads@0 241 return array(
eads@0 242 'mee_textarea' => array(
eads@0 243 '#input' => TRUE,
eads@0 244 '#columns' => array('value', 'format'), '#delta' => 0,
eads@0 245 '#process' => array('mee_textarea_process', 'dnd_process_textarea'),
eads@0 246 '#filter_value' => FILTER_FORMAT_DEFAULT,
eads@0 247 ),
eads@0 248 );
eads@0 249 }
eads@0 250
eads@0 251 /**
eads@0 252 * Implementation of hook_widget_settings().
eads@0 253 */
eads@0 254 function mee_widget_settings($op, $widget) {
eads@0 255 switch ($op) {
eads@0 256 case 'form':
eads@0 257 $form = array();
eads@0 258 $rows = (isset($widget['rows']) && is_numeric($widget['rows'])) ? $widget['rows'] : 5;
eads@0 259 $size = (isset($widget['size']) && is_numeric($widget['size'])) ? $widget['size'] : 60;
eads@0 260 $form['rows'] = array(
eads@0 261 '#type' => 'textfield',
eads@0 262 '#title' => t('Rows'),
eads@0 263 '#default_value' => $rows,
eads@0 264 '#element_validate' => array('_mee_widget_settings_row_validate'),
eads@0 265 '#required' => TRUE,
eads@0 266 );
eads@0 267 $form['size'] = array('#type' => 'hidden', '#value' => $size);
eads@0 268 return $form;
eads@0 269
eads@0 270 case 'save':
eads@0 271 return array('rows', 'size');
eads@0 272 }
eads@0 273 }
eads@0 274
eads@0 275 function _mee_widget_settings_row_validate($element, &$form_state) {
eads@0 276 $value = $form_state['values']['rows'];
eads@0 277 if (!is_numeric($value) || intval($value) != $value || $value <= 0) {
eads@0 278 form_error($element, t('"Rows" must be a positive integer.'));
eads@0 279 }
eads@0 280 }
eads@0 281
eads@0 282 function _mee_widget_settings_size_validate($element, &$form_state) {
eads@0 283 $value = $form_state['values']['size'];
eads@0 284 if (!is_numeric($value) || intval($value) != $value || $value <= 0) {
eads@0 285 form_error($element, t('"Size" must be a positive integer.'));
eads@0 286 }
eads@0 287 }
eads@0 288
eads@0 289 /**
eads@0 290 * Implementation of hook_widget().
eads@0 291 *
eads@0 292 * Attach a single form element to the form. It will be built out and
eads@0 293 * validated in the callback(s) listed in hook_elements. We build it
eads@0 294 * out in the callbacks rather than here in hook_widget so it can be
eads@0 295 * plugged into any module that can provide it with valid
eads@0 296 * $field information.
eads@0 297 *
eads@0 298 * Content module will set the weight, field name and delta values
eads@0 299 * for each form element. This is a change from earlier CCK versions
eads@0 300 * where the widget managed its own multiple values.
eads@0 301 *
eads@0 302 * If there are multiple values for this field, the content module will
eads@0 303 * call this function as many times as needed.
eads@0 304 *
eads@0 305 * @param $form
eads@0 306 * the entire form array, $form['#node'] holds node information
eads@0 307 * @param $form_state
eads@0 308 * the form_state, $form_state['values'][$field['field_name']]
eads@0 309 * holds the field's form values.
eads@0 310 * @param $field
eads@0 311 * the field array
eads@0 312 * @param $items
eads@0 313 * array of default values for this field
eads@0 314 * @param $delta
eads@0 315 * the order of this item in the array of subelements (0, 1, 2, etc)
eads@0 316 *
eads@0 317 * @return
eads@0 318 * the form item for a single element for this field
eads@0 319 */
eads@0 320 function mee_widget(&$form, &$form_state, $field, $items, $delta = 0) {
tom@5 321 if (isset($items[$delta]['value'])) {
tom@5 322 $items[$delta]['value'] = scald_sas_to_rendered($items[$delta]['value'], $field['mee_scald_editor_context'], TRUE);
tom@5 323 }
eads@0 324 $element = array(
eads@0 325 '#type' => $field['widget']['type'],
tom@5 326 '#default_value' => isset($items[$delta]) ? $items[$delta] : '',
eads@0 327 );
tom@5 328
eads@0 329 return $element;
eads@0 330 }
eads@0 331
eads@0 332 /**
eads@0 333 * Process an individual element.
eads@0 334 *
eads@0 335 * Build the form element. When creating a form using FAPI #process,
eads@0 336 * note that $element['#value'] is already set.
eads@0 337 *
eads@0 338 * The $fields array is in $form['#field_info'][$element['#field_name']].
eads@0 339 */
eads@0 340 function mee_textarea_process($element, $edit, $form_state, $form) {
eads@0 341 drupal_add_css(drupal_get_path('module', 'mee') .'/css/mee.css');
eads@0 342
eads@0 343 $field = $form['#field_info'][$element['#field_name']];
eads@0 344 $field_key = $element['#columns'][0];
eads@0 345 $element[$field_key] = array(
eads@0 346 '#type' => 'textarea',
eads@0 347 '#default_value' => isset($element['#value'][$field_key]) ? $element['#value'][$field_key] : NULL,
eads@0 348 '#rows' => !empty($field['widget']['rows']) ? $field['widget']['rows'] : 10,
eads@0 349 '#weight' => 0,
eads@0 350 // The following values were set by the content module and need
eads@0 351 // to be passed down to the nested element.
eads@0 352 '#title' => $element['#title'],
eads@0 353 '#description' => $element['#description'],
eads@0 354 '#required' => $element['#required'],
eads@0 355 '#field_name' => $element['#field_name'],
eads@0 356 '#type_name' => $element['#type_name'],
eads@0 357 '#delta' => $element['#delta'],
eads@0 358 '#columns' => $element['#columns'],
eads@0 359 '#prefix' => '<div class="mee-wrap-editor-library">',
eads@0 360 '#suffix' => '</div>',
eads@0 361 '#dnd-enabled' => TRUE,
eads@0 362 '#dnd-settings' => array(
eads@0 363 'drop_selector' => '#'. $element['#id'] .' .drop',
eads@0 364 'url' => $field['mee_dnd_callback_url'],
eads@0 365 ),
eads@0 366 );
eads@0 367
eads@0 368 if (!empty($field['mee_processing'])) {
eads@0 369 $filter_key = (count($element['#columns']) == 2) ? $element['#columns'][1] : 'format';
eads@0 370 $format = isset($element['#value'][$filter_key]) ? $element['#value'][$filter_key] : FILTER_FORMAT_DEFAULT;
eads@0 371 $parents = array_merge($element['#parents'] , array($filter_key));
eads@0 372 $element[$filter_key] = filter_form($format, 1, $parents);
eads@0 373 }
eads@0 374
eads@0 375 // Used so that hook_field('validate') knows where to flag an error.
eads@0 376 $element['_error_element'] = array(
eads@0 377 '#type' => 'value',
eads@0 378 '#value' => implode('][', array_merge($element['#parents'], array($field_key))),
eads@0 379 );
eads@0 380
eads@0 381
eads@0 382 return $element;
eads@0 383 }
eads@0 384
eads@0 385 /**
eads@0 386 * FAPI theme for an individual text elements.
eads@0 387 *
eads@0 388 * The textfield or textarea is already rendered by the
eads@0 389 * textfield or textarea themes and the html output
eads@0 390 * lives in $element['#children']. Override this theme to
eads@0 391 * make custom changes to the output.
eads@0 392 *
eads@0 393 * $element['#field_name'] contains the field name
eads@0 394 * $element['#delta] is the position of this element in the group
eads@0 395 */
eads@0 396 function theme_mee_textarea($element) {
eads@0 397 return $element['#children'];
eads@0 398 }
tom@2 399
tom@2 400
tom@2 401
tom@2 402
tom@2 403
tom@2 404
tom@2 405 /*******************************************************************************
tom@2 406 * SCALD HOOK IMPLEMENTATIONS
tom@2 407 ******************************************************************************/
tom@2 408
tom@2 409 /**
tom@2 410 * Implementation of hook_scald_provider().
tom@2 411 */
tom@2 412 function mee_scald_provider() {
tom@2 413 return array(
tom@2 414 'atoms' => array(
tom@5 415 'composite' => array(
tom@5 416 t('The MEE CCK field.'),
tom@5 417 ),
tom@2 418 ),
tom@2 419 );
tom@2 420 }
tom@2 421
tom@2 422
tom@2 423
tom@2 424 /**
tom@2 425 * Implementation of hook_scald_register_atom().
tom@2 426 */
tom@2 427 function mee_scald_register_atom($atom, $mode) {
tom@2 428
tom@2 429 } // end mee_scald_register_atom()
tom@2 430
tom@2 431
tom@2 432
tom@2 433 /**
tom@2 434 * Implementation of hook_scald_update_atom().
tom@2 435 */
tom@2 436 function mee_scald_update_atom($atom, $mode) {
tom@2 437
tom@2 438 } // end mee_scald_update_atom()
tom@2 439
tom@2 440
tom@2 441
tom@2 442 /**
tom@2 443 * Implementation of hook_scald_unregister_atom().
tom@2 444 */
tom@2 445 function mee_scald_unregister_atom($atom, $mode) {
tom@2 446
tom@2 447 } // end mee_scald_unregister_atom()
tom@2 448
tom@2 449
tom@2 450
tom@2 451 /**
tom@2 452 * Implementation of hook_scald_fetch().
tom@2 453 */
tom@2 454 function mee_scald_fetch(&$atom) {
tom@2 455 $atom->thumbnail_source = drupal_get_path('module', 'scald_composites') . '/assets/thumbnail_composite.png';
tom@2 456 } // end mee_scald_fetch()
tom@2 457
tom@2 458
tom@2 459
tom@2 460 /**
tom@2 461 * Implementation of hook_scald_prerender().
tom@2 462 */
tom@2 463 function mee_scald_prerender(&$atom, $mode) {
tom@2 464
tom@2 465 } // end mee_scald_prerender()
tom@2 466