Index: sifr.css =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/sifr/sifr.css,v retrieving revision 1.1 diff -u -p -r1.1 sifr.css --- sifr.css 21 Feb 2006 21:11:36 -0000 1.1 +++ sifr.css 18 Aug 2007 16:09:19 -0000 @@ -5,4 +5,17 @@ .sifr-font { font-size: 2em; vertical-align: middle; -} \ No newline at end of file +} + +.sifr-font-color { + float: left; + width: 14px; + height: 14px; + margin: 0 3px 0 0; + border: 1px solid black; +} + +.sifr-rule-op img { + margin: 0 6px 0 0; +} + Index: sifr.install =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/sifr/sifr.install,v retrieving revision 1.5 diff -u -p -r1.5 sifr.install --- sifr.install 30 Jan 2007 21:55:05 -0000 1.5 +++ sifr.install 19 Aug 2007 15:29:47 -0000 @@ -8,24 +8,11 @@ function sifr_install(){ case 'mysqli': db_query("CREATE TABLE {sifr} ( rid int(10) NOT NULL default '0', + plugin VARCHAR(50) NOT NULL default '', name varchar(50) NOT NULL default '', - font varchar(100) NOT NULL default '', selector varchar(255) NOT NULL default '', - color varchar(10) NOT NULL default '', - linkcolor varchar(10) NOT NULL default '', - hovercolor varchar(10) NOT NULL default '', - bgcolor varchar(10) NOT NULL default '', - transparent tinyint(3) NOT NULL default '0', + properties longtext NOT NULL default '', weight float NOT NULL default '0', - letterspacing varchar(10) NOT NULL default '', - fontsize varchar(10) NOT NULL default '', - paddingtop varchar(10) NOT NULL default '', - paddingright varchar(10) NOT NULL default '', - paddingbottom varchar(10) NOT NULL default '', - paddingleft varchar(10) NOT NULL default '', - textalign varchar(10) NOT NULL default '', - underline tinyint(3) NOT NULL default '0', - lettercase varchar(10) NOT NULL default '', UNIQUE KEY rid (rid), KEY rid_2 (rid) ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;"); @@ -71,3 +58,49 @@ function sifr_update_2() { } return $ret; } + +/** + * Add plugin name to rules table. + */ +function sifr_update_3() { + $ret = array(); + switch ($GLOBALS['db_type']) { + case 'mysql': + case 'mysqli': + $ret[] = update_sql("ALTER TABLE {sifr} ADD plugin VARCHAR(50) NOT NULL default '' AFTER rid"); + $ret[] = update_sql("UPDATE {sifr} SET plugin = 'sifr'"); + break; + + case 'pgsql': + break; + } + return $ret; +} + +/** + * Add column properties and serialize existing sIFR properties. + */ +function sifr_update_4() { + $ret = array(); + switch ($GLOBALS['db_type']) { + case 'mysql': + case 'mysqli': + $ret[] = update_sql("ALTER TABLE {sifr} ADD properties longtext NOT NULL default '' AFTER selector"); + $columns = array('font', 'color', 'linkcolor', 'hovercolor', 'bgcolor', 'transparent', 'letterspacing', 'fontsize', 'paddingtop', 'paddingright', 'paddingbottom', 'paddingleft', 'textalign', 'lettercase', 'underline'); + $result = db_query("SELECT rid, ". implode(', ', $columns) ." FROM {sifr}"); + while ($rule = db_fetch_array($result)) { + $rid = array_shift($rule); + $properties = serialize($rule); + $ret[] = update_sql("UPDATE {sifr} SET properties = '$properties' WHERE rid = $rid"); + } + foreach ($columns as $column) { + $ret[] = update_sql("ALTER TABLE {sifr} DROP COLUMN $column"); + } + break; + + case 'pgsql': + break; + } + return $ret; +} + Index: sifr.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/sifr/sifr.module,v retrieving revision 1.18 diff -u -p -r1.18 sifr.module --- sifr.module 11 Aug 2007 00:33:20 -0000 1.18 +++ sifr.module 20 Aug 2007 01:48:56 -0000 @@ -7,8 +7,11 @@ * sIFR Module for Drupal * by Jeff Robbins - www.lullabot.com * development sponsored by Bryght - * Implements sIFR capabilities for all pages. - * http://www.mikeindustries.com/sifr/ + * Implements text replacement capabilities for all pages. + * + * @todo Implement generic download handler for all generated files. + * @todo Allow different rules for each site. + * @todo Rename module to textreplacement or the like. */ /** @@ -16,20 +19,19 @@ */ function sifr_menu($may_cache) { $items = array(); + $access = user_access('administer site configuration'); if ($may_cache) { $items[] = array( - 'title' => t('sIFR'), + 'title' => t('Text replacement'), 'path' => 'admin/settings/sifr', 'description' => t('Configure which HTML text elements in your theme are rendered with Flash-based fonts.'), - // best way? - 'access' => user_access('administer site configuration'), + 'access' => $access, 'callback' => 'sifr_rules', ); $items[] = array( 'title' => t('Rules'), 'path' => 'admin/settings/sifr/rules', - // best way? - 'access' => user_access('administer site configuration'), + 'access' => $access, 'callback' => 'sifr_rules', 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -2, @@ -37,25 +39,16 @@ function sifr_menu($may_cache) { $items[] = array( 'title' => t('Add rule'), 'path' => 'admin/settings/sifr/addrule', - // best way? - 'access' => user_access('administer site configuration'), - 'callback' => 'sifr_edit_rule', + 'access' => $access, + 'callback' => 'drupal_get_form', + 'callback arguments' => 'sifr_add_rule', 'type' => MENU_LOCAL_TASK, 'weight' => -1, ); $items[] = array( - 'title' => t('Delete rule'), - 'path' => 'admin/settings/sifr/rules/delete', - // best way? - 'access' => user_access('administer site configuration'), - 'callback' => 'sifr_delete_confirm', - 'type' => MENU_CALLBACK, - ); - $items[] = array( 'title' => t('Manage fonts'), 'path' => 'admin/settings/sifr/manage', - // best way? - 'access' => user_access('administer site configuration'), + 'access' => $access, 'callback' => 'sifr_manage', 'type' => MENU_LOCAL_TASK, 'weight' => 2, @@ -68,26 +61,47 @@ function sifr_menu($may_cache) { 'type' => MENU_CALLBACK, ); $items[] = array( - 'title' => t('Download sifr file'), + 'title' => t('Download font file'), 'path' => 'sifr/download', 'callback' => 'sifr_octet_download', - 'access' => user_access('administer site configuration'), + 'access' => $access, 'type' => MENU_CALLBACK, ); } else { $items[] = array( + 'path' => 'admin/settings/sifr/regenerate', + 'access' => $access, + 'callback' => 'sifr_regenerate_rules', + 'type' => MENU_CALLBACK, + ); + $items[] = array( 'title' => t('Edit'), 'path' => 'admin/settings/sifr/edit', - 'access' => user_access('administer site configuration'), + 'access' => $access, 'callback' => 'sifr_edit_rule', 'type' => strpos($_GET['q'], 'admin/settings/sifr/edit') === 0 ? MENU_LOCAL_TASK : MENU_CALLBACK, 'weight' => 5, ); $items[] = array( + 'path' => 'admin/settings/sifr/duplicate', + 'access' => $access, + 'callback' => 'sifr_duplicate_rule', + 'type' => MENU_CALLBACK, + 'weight' => 5, + ); + $items[] = array( + 'title' => t('Delete rule'), + 'path' => 'admin/settings/sifr/rules/delete', + 'access' => $access, + 'callback' => 'drupal_get_form', + 'callback arguments' => 'sifr_delete_rule_form', + 'type' => MENU_CALLBACK, + ); + $items[] = array( 'title' => t('Delete font'), 'path' => 'admin/settings/sifr/deletefont', - 'access' => user_access('administer site configuration'), + 'access' => $access, 'callback' => 'sifr_fontdelete_confirm', 'type' => strpos($_GET['q'], 'admin/settings/sifr/deletefont') === 0 ? MENU_LOCAL_TASK : MENU_CALLBACK, 'weight' => 6, @@ -99,50 +113,118 @@ function sifr_menu($may_cache) { } /** + * Retrieve available plugins. + */ +function sifr_plugins() { + static $listing; + + if (isset($listing)) { + return $listing; + } + + $dir = drupal_get_path('module', 'sifr') .'/plugins'; + $listing = file_scan_directory($dir, '.+\.inc', array('.', '..', 'CVS', '.svn'), 0, FALSE, 'name'); + foreach ($listing as $plugin) { + include_once($plugin->filename); + $function = $plugin->name .'_sifr_plugin'; + if (function_exists($function)) { + $listing[$plugin->name] = $function(); + } + else { + // Prevent use of malformed plugins. + unset($listing[$plugin->name]); + } + } + + return $listing; +} + +/** * List the rules */ function sifr_rules() { + $plugins = sifr_plugins(); $rules = sifr_get_rules(); - $mypath = drupal_get_path('module', 'sifr'); - $header = array(t('Rule Name'), t('CSS Selector'), t('Font'), t('Colors'), '', ''); - $editimg = theme('image', $mypath .'/images/editor.png'); - $delimg = theme('image', $mypath .'/images/delete.png'); + $sifrdir = drupal_get_path('module', 'sifr'); + $header = array(t('Plugin'), t('Rule Name'), t('CSS Selector'), t('Font'), t('Colors'), t('Weight'), array('data' => t('Operations'), 'colspan' => 2)); + $rows = array(); + $img_edit = theme('image', $sifrdir .'/images/editor.png'); + $img_duplicate = theme('image', $sifrdir .'/images/copy.png'); + $img_delete = theme('image', $sifrdir .'/images/delete.png'); foreach ($rules as $r) { - $fontroot = substr($r->font, strrpos($r->font, '/') + 1); + $function = $r['plugin'] .'_sifr_rules'; + if (function_exists($function)) { + $fontstyle = $function($r); + } + $color_names = array( + 'color' => t('Font color'), + 'linkcolor' => t('Link color'), + 'hovervolor' => t('Hover color'), + 'bgcolor' => t('Background color'), + ); + $colors = ''; + foreach ($fontstyle['colors'] as $key => $color) { + $colors .= '
'; + } + $operations = array( + l($img_edit, 'admin/settings/sifr/edit/'. $r['rid'], array('title' => t('Edit'), 'class' => 'sifr-rule-op'), NULL, NULL, FALSE, TRUE), + l($img_duplicate, 'admin/settings/sifr/duplicate/'. $r['rid'], array('title' => t('Duplicate'), 'class' => 'sifr-rule-op'), NULL, NULL, FALSE, TRUE), + l($img_delete, 'admin/settings/sifr/rules/delete/'. $r['rid'], array('title' => t('Delete'), 'class' => 'sifr-rule-op'), NULL, NULL, FALSE, TRUE), + ); $rows[] = array( - $r->name, $r->selector, - $fontroot, - "
-
-
-
-
-
- ", - l($editimg .' '. t('edit'), 'admin/settings/sifr/edit/'. $r->rid, array(), NULL, NULL, FALSE, TRUE), - l($delimg .' '. t('delete'), 'admin/settings/sifr/rules/delete/'. $r->rid, array(), NULL, NULL, FALSE, TRUE)); + $plugins[$r['plugin']]['title'], + $r['name'], + $r['selector'], + $fontstyle['font'], + $colors, + $r['weight'], + implode('', $operations), + ); } - $output .= theme_table($header, $rows, array('style' => 'width:100%; clear:both;')); + $output .= theme_table($header, $rows, array('style' => 'width: 100%; clear: both;')); $output .= '

'; - $output .= l(t('Add another rule'), 'admin/settings/sifr/addrule') .'

'; - $output .= l(theme('image', $mypath .'/images/sifr.png', 'sIFR', 'Link to the sIFR', array()), 'http://www.mikeindustries.com/sifr/', array(), NULL, NULL, FALSE, TRUE); + $output .= l(t('Add another rule'), 'admin/settings/sifr/addrule'); + $output .= ' | '; + $output .= l(t('Regenerate rules'), 'admin/settings/sifr/regenerate'); + $output .= '

'; + + // Display logos of supported plugins. + $output .= '

'. t('Supported plugins') .'

'; + foreach ($plugins as $plugin) { + $output .= l(theme('image', $sifrdir .'/plugins/'. $plugin['name'] .'.png', $plugin['title'], 'Visit homepage of '. $plugin['title'], array()), $plugin['url'], array(), NULL, NULL, FALSE, TRUE); + } + + drupal_add_css(drupal_get_path('module', 'sifr') .'/sifr.css', 'module', 'all', FALSE); return $output; } /** - * Manage the .swf files + * Regenerate all JavaScript and Stylesheet files for all plugins and rules. + */ +function sifr_regenerate_rules() { + $active_plugins = variable_get('sifr_plugins', array()); + foreach ($active_plugins as $plugin) { + sifr_render_rules_js($plugin); + sifr_css_screen($plugin, FALSE); + } + + drupal_goto('admin/settings/sifr'); +} + +/** + * Manage font files. */ function sifr_manage() { $sifr = str_replace(' ', "%20", sifr_find_sifr()); - drupal_set_title(t('Manage sIFR fonts')); + drupal_set_title(t('Manage text replacement fonts')); $delimg = theme('image', drupal_get_path('module', 'sifr') .'/images/delete.png'); $filedir = file_directory_path() .'/sifr'; $header = array(t('Font'), t('Location'), ''); - foreach (sifr_get_swfs() as $file => $name) { + foreach (sifr_get_fonts() as $file => $name) { $editable = strpos($file, $filedir) === FALSE ? FALSE : TRUE; $rows[] = array( $name, @@ -159,42 +241,30 @@ function sifr_manage() { function sifr_upload() { $form['#attributes'] = array('enctype' => 'multipart/form-data'); - $instructions = t(' -

Good places to find sIFR fonts:

- -

Just download \'em from there and upload \'em here.

- -

To create your own sIFR font files:

-
    -
  1. Download these files to the same directory: !files
    2. -
  2. Open the file in Macromedia Flash.
    3. -
  3. Double-click the invisible textbox in the middle of the stage. If the "Properties" palette is not already visible, open it by selecting "Window > Properties", and select which font you\'d like to use from the drop down menu. If you select a TrueType font, you can also create bold and italic styles for your font by clicking on the "I" or "B" buttons. The standard sifr.fla file contains most of the English characters you will generally need. If you need to embed additional characters or languages, click the "Character" button and select more characters from there.
    4. -
  4. To export the new file, choose "File > Export" and save as fontname.swf
    5. -
  5. Upload the your font file below.
    6. -
', - array( - '!files' => l('sifr.fla', 'sifr/download/sifr.fla') .', '. l('customize_me.as', 'sifr/download/customize_me.as') .', '. l('dont_customize_me.as', 'sifr/download/dont_customize_me.as') - ) - ); + // Display instructions for each plugin. $form['instructions'] = array( - '#type' => 'fieldset', - '#collapsible' => TRUE, - '#collapsed' => TRUE, - '#title' => t('Instructions'), - '#attributes' => array('style' => 'margin-top: 15px'), - ); - $form['instructions']['instructions'] = array( - '#type' => 'markup', - '#value' => $instructions, + '#value' => '

', ); + $plugins = sifr_plugins(); + foreach ($plugins as $plugin) { + $function = $plugin['name'] .'_sifr_plugin_instructions'; + if (function_exists($function)) { + $form['instructions'][$plugin['name']] = array( + '#type' => 'fieldset', + '#collapsible' => TRUE, + '#collapsed' => TRUE, + '#title' => t('@plugin instructions', array('@plugin' => $plugin['title'])), + ); + $form['instructions'][$plugin['name']]['instructions'] = array( + '#type' => 'markup', + '#value' => $function(), + ); + } + } $form['sifrfile'] = array( '#type' => 'file', - '#title' => t('Upload sIFR font file'), - '#description' => t('Select the .swf file that you created using the instructions above.'), + '#title' => t('Upload font file'), + '#description' => t('Select the font file that you created using the instructions above.'), '#size' => 40, ); $form[] = array( @@ -226,7 +296,52 @@ function sifr_upload_submit($form_id, $f } /** - * Edit or create a new rule + * Create a new text replacement rule. + * + * Since multiple text replacement plugins can support the same font file types + * we need to ask for the plugin to use before a rule can be created. + */ +function sifr_add_rule() { + $form = array(); + + $form['plugin_select'] = array( + '#type' => 'fieldset', + '#title' => t('Text replacement plugin'), + ); + $form['plugin'] = array( + '#type' => 'value', + '#required' => TRUE, + ); + foreach (sifr_plugins() as $plugin) { + $function = $plugin['name'] .'_sifr_setup'; + if (function_exists($function)) { + if ($function()) { + $form['plugin_select'][$plugin['name']] = array( + '#type' => 'radio', + '#title' => $plugin['title'], + '#name' => 'plugin', + '#return_value' => $plugin['name'], + ); + } + } + } + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Next'), + ); + + return $form; +} + +function sifr_add_rule_submit($form_id, $values) { + if (isset($values['plugin'])) { + drupal_goto('admin/settings/sifr/edit/'. check_plain($values['plugin'])); + } +} + +/** + * Edit a text replacement rule. * * @param $edit * an array or object of rule parameters @@ -240,37 +355,60 @@ function sifr_edit_rule($edit = NULL) { drupal_goto('admin/settings/sifr/rules/delete/'. $edit); } else { - $edit = sifr_load_rule($edit); + $rule = sifr_load_rule($edit); } } - $edit = (array)$edit; + else if (is_string($edit)) { + $rule['plugin'] = check_plain($edit); + } + $font_select = $rule = (array)$rule; + $rules = array(); - $swfs = sifr_get_swfs(); - $rule->color = '#000000'; - $rule->linkcolor = '#000000'; - $rule->hovercolor = '#000000'; - $rule->bgcolor = '#FFFFFF'; - $myrules = array(); - foreach ($swfs as $path => $name) { - $rule->selector = "#font-". str_replace(array(' ', '_'), '-', $name); - $rule->font = $path; - $myrules[] = sifr_render_rule_js($rule); + // Override font colors for font selection. + $font_select['color'] = '#000000'; + $font_select['linkcolor'] = '#000000'; + $font_select['hovercolor'] = '#000000'; + $font_select['bgcolor'] = '#FFFFFF'; + $font_select['fontsize'] = '16px'; + $fonts = sifr_get_fonts($rule['plugin']); + foreach ($fonts as $path => $name) { + $font_select['selector'] = '.sifr-font-'. str_replace(array(' ', '_'), '-', $name); + $font_select['font'] = $path; + $rules[] = sifr_render_rule_js($font_select); + } + + // Ensure that plugin is properly loaded. + $function = $rule['plugin'] .'_sifr_load'; + if (function_exists($function)) { + $function(); } - drupal_add_js(sifr_wrap_rules($myrules), 'inline'); + sifr_css_screen($rule['plugin'], FALSE); + drupal_add_css(file_directory_path() .'/sifr/'. $rule['plugin'] .'-screen.css', 'module', 'screen', FALSE); + + drupal_add_js(sifr_wrap_rules($rule['plugin'], $rules, TRUE), 'inline'); - drupal_add_css(drupal_get_path('module', 'sifr') .'/sifr.css'); + drupal_add_css(drupal_get_path('module', 'sifr') .'/sifr.css', 'module', 'all', FALSE); - return drupal_get_form('sifr_rule', $edit); + return drupal_get_form('sifr_rule', $rule); } function sifr_rule($edit) { if ($edit['rid']) { - $form['rid'] = array('#type' => 'hidden', '#value' => $edit['rid']); - drupal_set_title(t('Edit sIFR rule %s', array('%s' => $edit['name']))); + $form['rid'] = array( + '#type' => 'hidden', + '#value' => $edit['rid'], + ); + drupal_set_title(t('Edit replacement rule %s', array('%s' => $edit['name']))); } else { - drupal_set_title(t('Add a new sIFR rule')); + drupal_set_title(t('Add a new text replacement rule')); } + $form['plugin'] = array( + '#type' => 'value', + '#value' => $edit['plugin'], + '#required' => TRUE, + ); + $form['basics'] = array( '#type' => 'fieldset', '#title' => t('Basics'), @@ -282,13 +420,11 @@ function sifr_rule($edit) { '#required' => TRUE, '#description' => t('The human readable name for this rule.'), ); - $form['basics']['selector'] = array( '#type' => 'textfield', - '#title' => t('CSS Selector'), + '#title' => t('Selector'), '#default_value' => $edit['selector'], - '#description' => t('

CSS selector for the elements you want to replace. -
'), + '#description' => t('A CSS / HTML selector for the elements you want to replace.'), '#required' => TRUE, ); $form['basics']['selectorhelp'] = array( @@ -299,162 +435,28 @@ function sifr_rule($edit) { ); $form['basics']['selectorhelp']['contents'] = array( '#type' => 'markup', - '#value' => t('
The supported CSS selectors are #, > and .. Whitespace is used to select descendants. Please use whitespace only for this, so instead of #foo > p use #foo>p. You can use multiple selectors by seperating them with a comma (",").
-
Example presets based on Bluemarine default elements: -
- page title
-
- node titles
-
- block titles
-
- comment titles
- Selectors may be dependent on your theme. Examine html source to find appropriate classes and ids being output by your current theme. -
'), - ); - - $form['basics']['font'] = array( - '#type' => 'fieldset', - ); - $form['basics']['font']['font'] = array( - '#title' => t('Font'), - '#type' => 'item', - '#description' => t("Select a font to use for this rule."), - '#required' => TRUE, - ); - - $swfs = sifr_get_swfs(); - foreach ($swfs as $path => $name) { - $form['basics']['font']['font'][]['font'] = array( - '#type' => 'radio', - '#title' => "". $name .'', - '#return_value' => $path, - '#default_value' => $edit['font'], - ); - } - - $form['colors'] = array( - '#type' => 'fieldset', - '#title' => t('Colors'), - '#collapsible' => TRUE, - '#collapsed' => TRUE, - '#description' => t('Each rule defines the colors for replaced text. Use six-character hexadecimal (CSS-style) color values preceeded by "#" to define text color, linked text color, hover-over link color, and text background color.'), + '#value' => t('

The supported CSS selectors are #, > and .. Whitespace is used to select descendants. Please use whitespace only for this, so instead of #foo > p use #foo>p. You may use multiple selectors by seperating them with a comma (",").

+

Example presets based on Bluemarine default elements:

+