------------------------------------------------------------
revno: 898
committer: Roger Martin <[email protected]>
branch nick: aikiframework
timestamp: Thu 2011-09-29 23:22:02 +0200
message:
new config library
added:
src/libs/config.php
modified:
src/bootstrap.php
src/sql/CreateTables.sql
--
lp:aikiframework
https://code.launchpad.net/~aikiframework-devel/aikiframework/trunk
Your team Aiki Framework Developers is subscribed to branch lp:aikiframework.
To unsubscribe from this branch go to
https://code.launchpad.net/~aikiframework-devel/aikiframework/trunk/+edit-subscription
=== modified file 'src/bootstrap.php'
--- src/bootstrap.php 2011-09-21 20:56:48 +0000
+++ src/bootstrap.php 2011-09-29 21:22:02 +0000
@@ -141,6 +141,8 @@
$aiki->load('url');
$aiki->load('site');
+$aiki->load('config');
+
$membership = $aiki->load("membership");
$aiki->load("languages");
=== added file 'src/libs/config.php'
--- src/libs/config.php 1970-01-01 00:00:00 +0000
+++ src/libs/config.php 2011-09-29 21:22:02 +0000
@@ -0,0 +1,338 @@
+<?php
+
+/**
+ * Aiki Framework (PHP)
+ *
+ * LICENSE
+ *
+ * This source file is subject to the AGPL-3.0 license that is bundled
+ * with this package in the file LICENSE.
+ *
+ * @author Roger martin - Aikilab http://www.aikilab.com
+ * @copyright (c) 2008-2011 Aiki Lab Pte Ltd
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html
+ * @link http://www.aikiframework.org
+ * @todo admin and edit options.
+ * @category Aiki
+ * @package Library
+ * @filesource
+ *
+ */
+
+if(!defined('IN_AIKI')){die('No direct script access allowed');}
+
+
+/**
+ * A class to handle settings and configuration.
+ *
+ * This class provide support for multisite,multiview and multilangague
+ * configuration.
+ *
+ * @category Aiki
+ * @package Library
+ *
+ */
+
+
+ class config {
+
+ /**
+ * cache for site,view and language
+ * @access private
+ */
+ private $site, $view, $language;
+
+
+ /**
+ * Load configuration for actual site/view/language
+ *
+ * The constructor calls this methods, so use this method
+ * only when you want reload configuration.
+ *
+ * @return integer number of setting loaded.
+ *
+ * @global $aiki
+ */
+
+ function load_configuration(){
+ global $aiki, $config, $db;
+
+ // cache site,view, language
+ $this->site = $aiki->site->get_site();
+ $this->view = $aiki->site->view();
+ $this->language = $aiki->site->language();
+
+ if ( count($config) ){
+ $checkPrevious = " OR config_name IN ('". implode ("','" , array_keys($config)) ."')";
+ } else {
+ $checkPrevious = "";
+ }
+
+ // search autoload config setting and previuos config.
+ $sql = "SELECT config_selector, config_name, config_value ".
+ " FROM aiki_settings RIGHT JOIN aiki_configs ON setting_name=config_name".
+ " WHERE setting_autoload=1". $checkPrevious.
+ " ORDER by config_important DESC, config_weight DESC";
+
+ $values = $db->get_results($sql);
+ if ( !is_array($values) ){
+ return 0;
+ }
+ $prevName="";
+ $count = 0;
+
+ foreach ($values as $value ){
+ // only store first value than match selector.
+ if ($prevName!= $value->config_name &&
+ $aiki->match_pair($value->config_selector, $this->site, $this->view, $this->language) ){
+ $config[$value->config_name]= unserialize($value->config_value);
+ $prevName= $value->config_name;
+ $count++;
+ }
+ }
+ return $count;
+ }
+
+
+ /**
+ * Constructor.
+ *
+ * Cache site, language and view and load configuration.
+ *
+ */
+
+ function __construct(){
+ $this->load_configuration();
+ }
+
+ /**
+ * parse selector
+ *
+ * @return array Site,view,language as array or string.
+ * @access private
+ */
+
+ function selector($selector, $returnString=false){
+ $ret = array ($this->site, $this->view, $this->language);
+
+ switch ($selector) {
+ case "CURRENT":
+ break;
+ case "CURRENT_SITE_VIEW":
+ $ret[2]="*";
+ break;
+ case "CURRENT_SITE":
+ $ret[1]="*";
+ $ret[2]="*";
+ break;
+ case "CURRENT_VIEW":
+ $ret[0]="*";
+ $ret[2]="*";
+ break;
+ case "CURRENT_LANGUAGE":
+ $ret[0]="*";
+ $ret[1]="*";
+ break;
+ default:
+ $parts = explode("/", $selector. "/*/*/*",4) ; // be sure three will be extracted
+ $ret = array(
+ ($parts[0] ? $parts[0] : "*"),
+ ($parts[1] ? $parts[1] : "*"),
+ ($parts[2] ? $parts[2] : "*" ) );
+ }
+
+ return $returnString ? implode("/",$ret) : $ret;
+ }
+
+ /**
+ * get a setting
+ *
+ * You can define a default value, used when setting, and selector than can be
+ * a trio of site/view/languages (you can use *), or string like
+ * CURRENT (current site/view/language), CURRENT_SITE (only current site),
+ * CURRENT_VIEW, CURRENT_SITE_VIEW (without language ), CURRENT_LANGUAGE
+ * @param string $setting
+ * @param string $default Value to return if not found (false)
+ * @param string $selector (CURRENT is default)
+ * @return setting if foundm else $defaut.
+ * @global $db
+ * @global $config
+ * @global $aiki
+ */
+
+ function get( $setting, $default=false, $selector="CURRENT"){
+ global $db, $config, $aiki ;
+
+ if ( isset($config[$setting]) ){
+ return $config[$setting];
+ }
+
+ $values = $db->get_results (
+ "SELECT config_value, config_selector".
+ " FROM aiki_configs".
+ " WHERE config_name='". addslashes($setting) . "'".
+ " ORDER BY config_weight DESC" );
+
+ list($site,$view,$language)= $this->selector($selector);
+ if ( is_array($values) ){
+ foreach ( $values as $value ) {
+ if ( $aiki->match_pair($value->config_selector, $site, $view, $language ) ){
+ $ret= unserialize($value->config_value);
+ $config[$setting]= $ret;
+ return $ret;
+ }
+ }
+ }
+ return $default;
+ }
+
+ /**
+ * store a setting in memory, so it lives only on actual page.
+ *
+ * this functions overwrittes previous value of setting.
+ *
+ * @param string $setting
+ * @param string $value
+ *
+ * @global $config
+ */
+
+ function remember($setting, $value){
+ global $config;
+ $config[$setting]= $value ;
+ }
+
+
+ /**
+ * delete values for a setting
+ *
+ * Always deletes database and (optional) config.
+ *
+ * @param string $setting
+ * @param boolen $deleteConfig, if true, unsets $config[$setting]
+ *
+ * @global $config
+ * @globla $db
+ */
+
+ function delete_value($setting, $deleteConfig=false){
+ if ( $deleteConfig && isset($config[$setting]) ){
+ unset( $config[$setting]);
+ }
+ $db->query("DELETE FROM aiki_configs WHERE config_name='". addslashes($setting). "'");
+ }
+
+ /**
+ * set a setting permantely and for actual page if selector match.
+ *
+ * Selector have to habitual syntax (site/view/language) with all
+ * elements optional * ). You can add the literal '!important' if you
+ * want set rule as important.%
+ * Example: admin !important %
+ *
+ * @param string $setting
+ * @param string $value
+ * @param string $selector
+ * @return boolean true is setting has been saved in database
+ *
+ * @global $config
+ * @global $db
+ * @global $aiki
+ */
+
+ function set($setting, $value, $givenSelector="*"){
+ global $db, $config, $aiki;
+
+ if ( substr($givenSelector,-10)== "!important" ){
+ $important= 1;
+ $selector = trim(substr($givenSelector,0,-10));
+ } else {
+ $important= 0;
+ $selector = $givenSelector;
+ }
+
+ if ( $givenSelector== "CURRENT" ||
+ $givenSelector=="*" ||
+ $aiki->match_pair($givenSelector, $this->site, $this->view, $this->language ) ) {
+ // value will only store in config, in selector is current, * (all) or match against
+ // current enviroment.
+ $config[$setting]= $value ;
+ }
+
+ $parts = $this->selector($selector );
+
+ // Rules: a given site value 100, a view 10, a language only 1, * cero.
+ $weight .= ($parts[0] !="*" && $parts[0] !="" ? 100 : 00)+
+ ($parts[1] !="*" && $parts[1] !="" ? 10 : 00)+
+ ($parts[2] !="*" && $parts[2] !="" ? 1 : 00);
+
+ $name = addslashes($setting);
+ $selector = addslashes("{$parts[0]}/$parts[1]/$parts[2]");
+ $where = " WHERE config_name='$name' AND config_selector='$selector'";
+
+ if ( $db->get_var( "SELECT config_id FROM aiki_configs $where") ) {
+ $SQL= "UPDATE aiki_configs SET".
+ " config_name='%s',config_value='%s'," .
+ " config_important=%d, config_weight=%d, config_selector='%s'".
+ $where;
+ } else {
+ $SQL= "INSERT INTO aiki_configs".
+ " (config_name,config_value, config_important, config_weight, config_selector)" .
+ " VALUES ( '%s','%s',%d,%d,'%s') ";
+ }
+
+ $SQL = sprintf ($SQL,
+ $name,
+ addslashes(serialize($value)),
+ $important,
+ $weight,
+ $selector );
+ return $db->query ($SQL) ;
+
+ }
+
+ }
+
+
+/**
+ * Shortcut for aiki->config->get
+ *
+ * You can define a default value, used when setting, and selector than can be
+ * a trio of site/view/languages (you can use *), or string like
+ * CURRENT (current site/view/language), CURRENT_SITE (only current site),
+ * CURRENT_VIEW, CURRENT_SITE_VIEW (without language ), CURRENT_LANGUAGE
+ * @param string $setting
+ * @param string $default Value to return if not faound (false)
+ * @param string $selector (CURRENT is default)
+ * @return setting if found.
+ *
+ * @global $aiki
+ */
+
+ function config ($setting, $default=false, $selector="CURRENT"){
+ global $aiki;
+ return $aiki->config->get($setting, $default, $selector);
+ }
+
+/**
+ * Shortcut for aiki->config->set
+ *
+ * set a setting permantely and for actual page if selector match.
+ *
+ * Selector have to habitual syntax (site/view/language) with all
+ * elements optional * ). You can add the literal '!important' if you
+ * want set rule as important.%
+ * Example: admin !important %
+ *
+ * @param string $setting
+ * @param string $value to set
+ * @param string $selector (CURRENT is default)
+ * @return boolean true is setting has been saved in database
+ *
+ * @global $aiki
+ */
+
+ function config_set ($setting, $dvalue, $selector="*"){
+ global $aiki;
+ return $aiki->config->set($setting, $value, $selector="CURRENT");
+ }
=== modified file 'src/sql/CreateTables.sql'
--- src/sql/CreateTables.sql 2011-09-21 20:56:48 +0000
+++ src/sql/CreateTables.sql 2011-09-29 21:22:02 +0000
@@ -33,6 +33,34 @@
-- ------------------------------------------------------
+CREATE TABLE IF NOT EXISTS aiki_settings (
+ setting_id int(11) NOT NULL AUTO_INCREMENT,
+ setting_name varchar(32) NOT NULL,
+ setting_description text NOT NULL,
+ setting_group text NOT NULL,
+ setting_edit text NOT NULL,
+ setting_autoload int(11) NOT NULL,
+ PRIMARY KEY (setting_id),
+ KEY setting_name (setting_name)
+) ENGINE=MyISAM CHARSET=utf8;
+
+-- ------------------------------------------------------
+
+CREATE TABLE IF NOT EXISTS aiki_configs (
+ config_id int(11) NOT NULL AUTO_INCREMENT,
+ config_name varchar(32) NOT NULL,
+ config_value text NOT NULL,
+ config_selector varchar(94) NOT NULL,
+ config_important int(11) NOT NULL,
+ config_weight int(11) NOT NULL,
+ PRIMARY KEY (config_id),
+ KEY config_name (config_name),
+ KEY config_important (config_important),
+ KEY config_weight (config_weight)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 ;
+
+-- ------------------------------------------------------
+
CREATE TABLE IF NOT EXISTS aiki_dictionary (
term_id int(11) NOT NULL AUTO_INCREMENT,
app_id int(11) NOT NULL,
@@ -151,36 +179,36 @@
view_description text NOT NULL,
PRIMARY KEY (view_id),
KEY view_prefix (view_prefix),
- KEY view_site (view_site`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8;
-
--- ------------------------------------------------------
-
-CREATE TABLE IF NOT EXISTS `aiki_plugins` (
- `plugin_id` int(11) NOT NULL AUTO_INCREMENT,
- `plugin_name` varchar(64) NOT NULL,
- `plugin_class_name` varchar(64) NOT NULL,
- `plugin_short_description` text NOT NULL,
- `plugin_description` text NOT NULL,
- `plugin_author` varchar(64) NOT NULL,
- `plugin_version` varchar(32) NOT NULL,
- `plugin_file` varchar(96) NOT NULL,
- `plugin_state` varchar(12) NOT NULL,
- `plugin_default_values` text NOT NULL,
- PRIMARY KEY (`plugin_id`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8;
-
--- ------------------------------------------------------
-
-CREATE TABLE IF NOT EXISTS `aiki_plugin_configurations` (
- `plconf_id` int(11) NOT NULL AUTO_INCREMENT,
- `plconf_active` varchar(11) NOT NULL,
- `plconf_plugin_id` int(11) NOT NULL,
- `plconf_routes` text NOT NULL,
- `plconf_priority` int(11) NOT NULL,
- `plconf_values` text NOT NULL,
- PRIMARY KEY (`plconf_id`),
- KEY `plconf_plugin_id` (`plconf_plugin_id`)
+ KEY view_site (view_site)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8;
+
+-- ------------------------------------------------------
+
+CREATE TABLE IF NOT EXISTS aiki_plugins (
+ plugin_id int(11) NOT NULL AUTO_INCREMENT,
+ plugin_name varchar(64) NOT NULL,
+ plugin_class_name varchar(64) NOT NULL,
+ plugin_short_description text NOT NULL,
+ plugin_description text NOT NULL,
+ plugin_author varchar(64) NOT NULL,
+ plugin_version varchar(32) NOT NULL,
+ plugin_file varchar(96) NOT NULL,
+ plugin_state varchar(12) NOT NULL,
+ plugin_default_values text NOT NULL,
+ PRIMARY KEY (plugin_id)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8;
+
+-- ------------------------------------------------------
+
+CREATE TABLE IF NOT EXISTS aiki_plugin_configurations (
+ plconf_id int(11) NOT NULL AUTO_INCREMENT,
+ plconf_active varchar(11) NOT NULL,
+ plconf_plugin_id int(11) NOT NULL,
+ plconf_routes text NOT NULL,
+ plconf_priority int(11) NOT NULL,
+ plconf_values text NOT NULL,
+ PRIMARY KEY (plconf_id),
+ KEY plconf_plugin_id (plconf_plugin_id)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;
-- ------------------------------------------------------
_______________________________________________
Mailing list: https://launchpad.net/~aikiframework-devel
Post to : [email protected]
Unsubscribe : https://launchpad.net/~aikiframework-devel
More help : https://help.launchpad.net/ListHelp
