From df29ffbde72e88635f454d5d6d84c5a7209460f3 Mon Sep 17 00:00:00 2001 From: vdigital Date: Mon, 14 Jul 2008 21:42:40 +0000 Subject: Feature template-extension based on 2006 chrisaga's idea. chrisaga wrote: "If you want to make some template customization without building a brand new template, you should use ..." git-svn-id: http://piwigo.org/svn/trunk@2434 68402e56-0260-453c-a942-63ccdbb3a9ee --- admin.php | 1 + admin/extend_for_templates.php | 213 +++++++++++++++++++++ admin/template/yoga/admin.tpl | 1 + admin/template/yoga/admin/extend_for_templates.tpl | 34 ++++ admin/template/yoga/theme/admin/themeconf.inc.php | 1 + include/template.class.php | 28 ++- install/db/72-database.php | 48 +++++ language/en_UK/admin.lang.php | 8 + language/en_UK/help/extend_for_templates.html | 98 ++++++++++ language/fr_FR/admin.lang.php | 10 +- language/fr_FR/help/extend_for_templates.html | 98 ++++++++++ .../distributed/samples/my-picture.tpl | 35 ++++ .../distributed/samples/my-thumbnails.tpl | 36 ++++ .../distributed/samples/my-thumbnails2.tpl | 36 ++++ 14 files changed, 643 insertions(+), 4 deletions(-) create mode 100644 admin/extend_for_templates.php create mode 100644 admin/template/yoga/admin/extend_for_templates.tpl create mode 100644 install/db/72-database.php create mode 100644 language/en_UK/help/extend_for_templates.html create mode 100644 language/fr_FR/help/extend_for_templates.html create mode 100644 template-extension/distributed/samples/my-picture.tpl create mode 100644 template-extension/distributed/samples/my-thumbnails.tpl create mode 100644 template-extension/distributed/samples/my-thumbnails2.tpl diff --git a/admin.php b/admin.php index f932b53a4..adc654879 100644 --- a/admin.php +++ b/admin.php @@ -78,6 +78,7 @@ $template->assign( 'U_ADVANCED_FEATURE'=> $link_start.'advanced_feature', 'U_CONFIG_GENERAL'=> $link_start.'configuration', 'U_CONFIG_DISPLAY'=> $conf_link.'default', + 'U_CONFIG_EXTENTS'=> $link_start.'extend_for_templates', 'U_CATEGORIES'=> $link_start.'cat_list', 'U_MOVE'=> $link_start.'cat_move', 'U_CAT_OPTIONS'=> $link_start.'cat_options', diff --git a/admin/extend_for_templates.php b/admin/extend_for_templates.php new file mode 100644 index 000000000..c6319368a --- /dev/null +++ b/admin/extend_for_templates.php @@ -0,0 +1,213 @@ + 0 ) + { + $extents[] = substr($path, 21); + } + } + return $extents; +} +// +-----------------------------------------------------------------------+ +// initialization | +// +-----------------------------------------------------------------------+ + +if (!defined('PHPWG_ROOT_PATH')) { die('Hacking attempt!'); } +include_once(PHPWG_ROOT_PATH.'admin/include/functions.php'); +check_status(ACCESS_ADMINISTRATOR); + +$tpl_extension = isset($conf['extents_for_templates']) ? + unserialize($conf['extents_for_templates']) : array(); +$new_extensions = get_extents(); + +/* Selective URLs keyword */ +$relevant_parameters = array( + '----------', + 'category', + 'favorites', + 'most_visited', + 'best_rated', + 'recent_pics', + 'recent_cats', + 'created-monthly-calendar', + 'posted-monthly-calendar', + 'search', + 'flat', + 'list',); /* <=> Random */ + $query = ' +SELECT permalink + FROM '.CATEGORIES_TABLE.' + WHERE permalink IS NOT NULL +'; + +/* Add active permalinks */ +$permalinks = array_from_query($query, 'permalink'); +$relevant_parameters = array_merge($relevant_parameters, $permalinks); + +/* Link all supported templates to their respective handle */ +$eligible_templates = array( + '----------' => 'N/A', + 'about.tpl' => 'about', + 'identification.tpl' => 'identification', + 'mainpage_categories.tpl' => 'index_category', + 'thumbnails.tpl' => 'index_thumbnails', + 'redirect.tpl' => 'redirect', + 'menubar.tpl' => 'menubar', + 'header.tpl' => 'header', + 'footer.tpl' => 'tail', + 'index.tpl' => 'index', + 'nbm.tpl' => 'nbm', + 'notification.tpl' => 'notification', + 'picture_content.tpl' => 'default_content', + 'slideshow.tpl' => 'picture', /* => slideshow is missing */ + 'picture.tpl' => 'picture', + 'popuphelp.tpl' => 'popuphelp', + 'profile.tpl' => 'profile', + 'profile_content.tpl' => 'profile_content', + 'register.tpl' => 'register', + 'search.tpl' => 'search', + 'search_rules.tpl' => 'search_rules', + 'tags.tpl' => 'tags', + 'upload.tpl' => 'upload',); + $flip_templates = array_flip($eligible_templates); +// +-----------------------------------------------------------------------+ +// | selected templates | +// +-----------------------------------------------------------------------+ + +if (isset($_POST['submit']) and !is_adviser()) +{ + $replacements = array(); + $i = 0; + while (isset($_POST['reptpl'][$i])) + { + $newtpl = $_POST['reptpl'][$i]; + $original = $_POST['original'][$i]; + $handle = $eligible_templates[$original]; + $url_keyword = $_POST['url'][$i]; + if ($url_keyword == '----------') $url_keyword = 'N/A'; + if ($handle != 'N/A') + { + $replacements[$newtpl] = array($handle, $url_keyword); + } + $i++; + } + $conf['extents_for_templates'] = serialize($replacements); + $tpl_extension = $replacements; + /* ecrire la nouvelle conf */ + $query = " +UPDATE ".CONFIG_TABLE." + SET value = '". $conf['extents_for_templates'] ."' +WHERE param = 'extents_for_templates';"; + if (pwg_query($query)) + { + array_push($page['infos'], + l10n('Templates recorded.')); + } +} + +// +-----------------------------------------------------------------------+ +// | template init | +// +-----------------------------------------------------------------------+ + +/* Clearing (remove old extents, add new ones) */ +foreach ($tpl_extension as $file => $conditions) +{ + if ( !in_array($file,$new_extensions) ) unset($tpl_extension[$file]); + else $new_extensions = array_diff($new_extensions,array($file)); +} +foreach ($new_extensions as $file) +{ + $tpl_extension[$file] = array('N/A' => 'N/A'); +} + +$template->set_filenames(array('extend_for_templates' + => 'admin/extend_for_templates.tpl')); + +$base_url = PHPWG_ROOT_PATH.'admin.php?page=extend_for_templates'; + +$template->assign( + array( + 'U_HELP' => get_root_url().'popuphelp.php?page=extend_for_templates', + )); +ksort($tpl_extension); +foreach ($tpl_extension as $file => $conditions) +{ + $handle = $conditions[0]; + $url_keyword = $conditions[1]; + { + $template->append('extents', + array( + 'replacer' => $file, + 'url_parameter' => $relevant_parameters, + 'original_tpl' => array_keys($eligible_templates), + 'selected_tpl' => $flip_templates[$handle], + 'selected_url' => $url_keyword,) + ); + } +} +// +-----------------------------------------------------------------------+ +// | html code display | +// +-----------------------------------------------------------------------+ + +$template->assign_var_from_handle('ADMIN_CONTENT', 'extend_for_templates'); +?> \ No newline at end of file diff --git a/admin/template/yoga/admin.tpl b/admin/template/yoga/admin.tpl index 1c5c13035..e0d44a17e 100644 --- a/admin/template/yoga/admin.tpl +++ b/admin/template/yoga/admin.tpl @@ -23,6 +23,7 @@ diff --git a/admin/template/yoga/admin/extend_for_templates.tpl b/admin/template/yoga/admin/extend_for_templates.tpl new file mode 100644 index 000000000..fdac49b7d --- /dev/null +++ b/admin/template/yoga/admin/extend_for_templates.tpl @@ -0,0 +1,34 @@ +{* $Id$ *} +

{'extend_for_templates'|@translate}

+
+{if isset($extents)} +

{'Replacement of original templates'|@translate}

+
+ + + + + + + {foreach from=$extents item=tpl name=extent_loop} + + + + + + {/foreach} +
{'Replacers'|@translate}{'Original templates'|@translate}{'Optional URL keyword'|@translate}
+ + {$tpl.replacer} + + {html_options name=original[] output=$tpl.original_tpl values=$tpl.original_tpl selected=$tpl.selected_tpl} + + {html_options name=url[] output=$tpl.url_parameter values=$tpl.url_parameter selected=$tpl.selected_url} +
+ {if !is_adviser()} +

+ +

+ {/if} +
+{/if} \ No newline at end of file diff --git a/admin/template/yoga/theme/admin/themeconf.inc.php b/admin/template/yoga/theme/admin/themeconf.inc.php index 9629b274f..e3b6fc63e 100644 --- a/admin/template/yoga/theme/admin/themeconf.inc.php +++ b/admin/template/yoga/theme/admin/themeconf.inc.php @@ -8,6 +8,7 @@ function selected_admin_menu() { switch ($_GET['page']) { case 'configuration': + case 'extend_for_templates': return 1; case 'site_manager': case 'site_update': diff --git a/include/template.class.php b/include/template.class.php index 1fd3c94ac..e7ab39b8d 100644 --- a/include/template.class.php +++ b/include/template.class.php @@ -145,22 +145,44 @@ class Template { */ function set_filenames($filename_array) { + global $conf; if (!is_array($filename_array)) { return false; } - reset($filename_array); + $tpl_extension = isset($conf['extents_for_templates']) ? + unserialize($conf['extents_for_templates']) : array(); while(list($handle, $filename) = each($filename_array)) { if (is_null($filename)) unset( $this->files[$handle] ); else - $this->files[$handle] = $filename; + { + if (!isset($this->files[$handle])) $this->files[$handle] = $filename; + foreach ($tpl_extension as $file => $conditions) + { + $localtpl = './template-extension/' . $file; + if ($handle == $conditions[0] and + (stripos(implode('/',array_flip($_GET)),$conditions[1])>0 + or $conditions[1] == 'N/A') + and file_exists($localtpl)) + { /* examples: Are best_rated, created-monthly-calendar, list, ... set? */ + $this->files[$handle] = '../.' . $localtpl; + /* assign their tpl-extension */ + /* For test purpose: Do advanced users need a php access? */ + // $localphp = '../.' . substr($localtpl,0,-3).'php'; + // if (file_exists($localphp)) @include_once($localphp); + } + } + } } return true; } - + function on_extension($key, $tlpname) + { + return $tplname; + } /** see smarty assign http://www.smarty.net/manual/en/api.assign.php */ function assign($tpl_var, $value = null) { diff --git a/install/db/72-database.php b/install/db/72-database.php new file mode 100644 index 000000000..d43c2f937 --- /dev/null +++ b/install/db/72-database.php @@ -0,0 +1,48 @@ + diff --git a/language/en_UK/admin.lang.php b/language/en_UK/admin.lang.php index 6f73d4b8d..129623864 100644 --- a/language/en_UK/admin.lang.php +++ b/language/en_UK/admin.lang.php @@ -649,4 +649,12 @@ $lang['Deleted on'] = 'Deleted on'; $lang['Last hit'] = 'Last hit'; $lang['Hits'] = 'Hits'; $lang['GD library is missing'] = 'GD library is missing'; +$lang['conf_extents'] = 'Templates'; +$lang['extend_for_templates'] = 'Extend for templates'; +$lang['Replacement of original templates'] = + 'Replacement of original templates by customized templates from template-extension subfolder'; +$lang['Replacers'] = 'Replacers (customized templates)'; +$lang['Original templates'] = 'Original templates'; +$lang['Optional URL keyword'] = 'Optional URL keyword'; +$lang['Templates recorded.'] = 'Templates configuration has been recorded.'; ?> diff --git a/language/en_UK/help/extend_for_templates.html b/language/en_UK/help/extend_for_templates.html new file mode 100644 index 000000000..8e2c7ac6b --- /dev/null +++ b/language/en_UK/help/extend_for_templates.html @@ -0,0 +1,98 @@ +

Extend for templates configuration

+ +

Goal

+

Define replacement conditions for each template from template-extension +(template called "replacer").

+ +

"original template" from ./template/yoga (or any other than yoga) + will be replaced by a "replacer" if the replacer is linked to this "original template" + (and optionally, when the requested URL contains an "optional URL keyword").

+ +

"Optional URL keywords" are those you can find after the module name in URLs.

+ +

Therefore "Optional URL keywords" can be an active "permalink" +(see permalinks in our documentation for further explanation).

+ +

Read: `Warning` usage conditions.

+ +

What are template extensions?

+ +

This configuration tool is powerfull for beginners and advanced users. +By FTP, in the template-extension folder, the Webmaster can duplicate a lot of + the distributed .tpl files ("original template") with a different name + ("replacer"). + + "Original templates", current original supported templates are:

+ + +

Where can I find "original templates"?

+ +

Distributed original templates are in template/yoga/ +(don't edit them in place for upgrade perspectives). So with "original templates", +any webmaster can create his "replacers (customized templates)".

+ +

Where should I save "replacers"?

+ +

Replacers (customized templates) must be placed in the +template-extension folder (or its subfolders). +Replacers can have any filename with the .tpl extension. For example: template-extension/my-extension/video.tpl.

+ + +

How can I activate my "replacers"?

+

An original template should be assigned to each + replacer (customized templates) to activate the related replacements. + This is the goal of "Extend for templates" in the Configuration Administration menu.

+ +

If you select an optional URL keyword then replacements +will be operate only on pages with this keyword. For example: index.php?/most_visited

+ +

Advanced users will use permalinks as optional URL + keyword.

+

How can I deactivate my "replacers"?

+ + +

Warnings

+ \ No newline at end of file diff --git a/language/fr_FR/admin.lang.php b/language/fr_FR/admin.lang.php index b1051c7a5..60981ae2e 100644 --- a/language/fr_FR/admin.lang.php +++ b/language/fr_FR/admin.lang.php @@ -649,4 +649,12 @@ $lang['Deleted on'] = 'Effacé le'; $lang['Last hit'] = 'Dernier accès'; $lang['Hits'] = 'Utilisations'; $lang['GD library is missing'] = 'la bibliothèque GD est manquante'; -?> +$lang['conf_extents'] = 'Templates (modèles)'; +$lang['extend_for_templates'] = 'Etendre les templates'; +$lang['Replacement of original templates'] = + 'Remplacement des templates d\'origine par vos templates adaptés du dossier template-extension'; +$lang['Replacers'] = 'Remplaçants (templates modifiés)'; +$lang['Original templates'] = 'Templates d\'origine'; +$lang['Optional URL keyword'] = 'Paramètre facultatif de l\'URL'; +$lang['Templates recorded.'] = 'La configuration des templates a été enregistrée.'; +?> \ No newline at end of file diff --git a/language/fr_FR/help/extend_for_templates.html b/language/fr_FR/help/extend_for_templates.html new file mode 100644 index 000000000..8e2c7ac6b --- /dev/null +++ b/language/fr_FR/help/extend_for_templates.html @@ -0,0 +1,98 @@ +

Extend for templates configuration

+ +

Goal

+

Define replacement conditions for each template from template-extension +(template called "replacer").

+ +

"original template" from ./template/yoga (or any other than yoga) + will be replaced by a "replacer" if the replacer is linked to this "original template" + (and optionally, when the requested URL contains an "optional URL keyword").

+ +

"Optional URL keywords" are those you can find after the module name in URLs.

+ +

Therefore "Optional URL keywords" can be an active "permalink" +(see permalinks in our documentation for further explanation).

+ +

Read: `Warning` usage conditions.

+ +

What are template extensions?

+ +

This configuration tool is powerfull for beginners and advanced users. +By FTP, in the template-extension folder, the Webmaster can duplicate a lot of + the distributed .tpl files ("original template") with a different name + ("replacer"). + + "Original templates", current original supported templates are:

+ + +

Where can I find "original templates"?

+ +

Distributed original templates are in template/yoga/ +(don't edit them in place for upgrade perspectives). So with "original templates", +any webmaster can create his "replacers (customized templates)".

+ +

Where should I save "replacers"?

+ +

Replacers (customized templates) must be placed in the +template-extension folder (or its subfolders). +Replacers can have any filename with the .tpl extension. For example: template-extension/my-extension/video.tpl.

+ + +

How can I activate my "replacers"?

+

An original template should be assigned to each + replacer (customized templates) to activate the related replacements. + This is the goal of "Extend for templates" in the Configuration Administration menu.

+ +

If you select an optional URL keyword then replacements +will be operate only on pages with this keyword. For example: index.php?/most_visited

+ +

Advanced users will use permalinks as optional URL + keyword.

+

How can I deactivate my "replacers"?

+ + +

Warnings

+ \ No newline at end of file diff --git a/template-extension/distributed/samples/my-picture.tpl b/template-extension/distributed/samples/my-picture.tpl new file mode 100644 index 000000000..4e81ff696 --- /dev/null +++ b/template-extension/distributed/samples/my-picture.tpl @@ -0,0 +1,35 @@ +{* $Id$ *} + +
+
+ {'home'|@translate} + {$LEVEL_SEPARATOR}{$SECTION_TITLE} + {$LEVEL_SEPARATOR}{$current.TITLE} +
+
+ +{if !empty($PLUGIN_PICTURE_BEFORE)}{$PLUGIN_PICTURE_BEFORE}{/if} +
+
+ {if isset($PLUGIN_PICTURE_ACTIONS)}{$PLUGIN_PICTURE_ACTIONS}{/if} +
+ {include file=$FILE_PICTURE_NAV_BUTTONS} +
+ +
+{$ELEMENT_CONTENT} + +
+ +{if isset($previous) } + +{/if} +{if isset($next) } + +{/if} + +{if !empty($PLUGIN_PICTURE_AFTER)}{$PLUGIN_PICTURE_AFTER}{/if} diff --git a/template-extension/distributed/samples/my-thumbnails.tpl b/template-extension/distributed/samples/my-thumbnails.tpl new file mode 100644 index 000000000..df39ab019 --- /dev/null +++ b/template-extension/distributed/samples/my-thumbnails.tpl @@ -0,0 +1,36 @@ +{* $Id$ *} + +{if !empty($thumbnails)} + +{/if} \ No newline at end of file diff --git a/template-extension/distributed/samples/my-thumbnails2.tpl b/template-extension/distributed/samples/my-thumbnails2.tpl new file mode 100644 index 000000000..0f17542d1 --- /dev/null +++ b/template-extension/distributed/samples/my-thumbnails2.tpl @@ -0,0 +1,36 @@ +{* $Id$ *} + +{if !empty($thumbnails)} + +{/if} \ No newline at end of file -- cgit v1.2.3