From 0890410b1d9fddbdf7e85e2d706bb222432d0699 Mon Sep 17 00:00:00 2001 From: sakamocchi Date: Thu, 5 Apr 2012 08:18:34 +0900 Subject: [PATCH] =?utf8?q?Skin=E3=82=AF=E3=83=A9=E3=82=B9=E3=81=AE?= =?utf8?q?=E3=82=B3=E3=83=BC=E3=83=89=E3=83=95=E3=82=A9=E3=83=BC=E3=83=9E?= =?utf8?q?=E3=83=83=E3=83=88?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit --- nucleus/libs/SKIN.php | 523 +++++++++++++++++++++++++++++--------------------- 1 file changed, 299 insertions(+), 224 deletions(-) diff --git a/nucleus/libs/SKIN.php b/nucleus/libs/SKIN.php index dde4674..991c29c 100644 --- a/nucleus/libs/SKIN.php +++ b/nucleus/libs/SKIN.php @@ -26,28 +26,31 @@ require_once dirname(__FILE__) . '/ACTIONS.php'; class Skin { // after creating a SKIN object, evaluates to true when the skin exists - var $isValid; + private $isValid; // skin characteristics. Use the getXXX methods rather than accessing directly - var $id; - var $description; - var $contentType; - var $includeMode; // either 'normal' or 'skindir' - var $includePrefix; - var $name; + private $id; + private $description; + private $contentType; + private $includeMode; // either 'normal' or 'skindir' + private $includePrefix; + private $name; /** + * Skin::__construct() * Constructor for a new SKIN object * - * @param $id - * id of the skin + * @param integer $id id of the skin + * @return void */ - function SKIN($id) + public function __construct($id) { - $this->id = intval($id); + $this->id = (integer) $id; // read skin name/description/content type - $res = sql_query('SELECT * FROM '.sql_table('skin_desc').' WHERE sdnumber=' . $this->id); + $query = "SELECT * FROM %s WHERE sdnumber=%d"; + $query = sprintf($query, sql_table('skin_desc'), (integer) $this->id); + $res = sql_query($query); $obj = sql_fetch_object($res); $this->isValid = (sql_num_rows($res) > 0); if ( !$this->isValid ) @@ -60,124 +63,162 @@ class Skin $this->contentType = $obj->sdtype; $this->includeMode = $obj->sdincmode; $this->includePrefix = $obj->sdincpref; - + return; } /** + * Skin::getID() * Get SKIN id + * + * @param void + * @return integer id for this skin instance */ - function getID() + public function getID() { - return $this->id; + return (integer) $this->id; } /** + * Skin::getName() * Get SKIN name + * + * @param void + * @return string name of this skin instance */ - function getName() + public function getName() { - return $this->name; + return (string) $this->name; } /** + * Skin::getDescription() * Get SKIN description + * + * @param void + * @return string description of this skin instance */ - function getDescription() + public function getDescription() { - return $this->description; + return (string) $this->description; } /** + * Skin::getContentType() * Get SKIN content type - * * e.g. text/xml, text/html, application/atom+xml + * + * @param void + * @return string name of this skin instance */ - function getContentType() + public function getContentType() { - return $this->contentType; + return (string) $this->contentType; } /** + * Skin::getIncludeMode() * Get include mode of the SKIN * * Returns either 'normal' or 'skindir': * 'normal': if a all data of the skin can be found in the databse * 'skindir': if the skin has data in the it's skin driectory + * + * @param void + * @return string normal/skindir */ - function getIncludeMode() + public function getIncludeMode() { - return $this->includeMode; + return (string) $this->includeMode; } /** + * Skin::getIncludePrefix() * Get include prefix of the SKIN * * Get name of the subdirectory (with trailing slash) where * the files of the current skin can be found (e.g. 'default/') + * + * @param void + * @return string include prefix of this skin instance */ - function getIncludePrefix() + public function getIncludePrefix() { - return $this->includePrefix; + return (string) $this->includePrefix; } /** + * Skin::exists() * Checks if a skin with a given shortname exists - * @param string $name Skin short name - * @return int number of skins with the given ID + * * @static + * @param string $name Skin short name + * @return integer number of skins with the given ID */ - function exists($name) + static public function exists($name) { - return quickQuery('select count(*) as result FROM ' . sql_table('skin_desc') . ' WHERE sdname="' . sql_real_escape_string($name) . '"') > 0; + $query = "SELECT COUNT (*) AS result FROM %s WHERE sdname='%s';"; + $query = sprintf($query, sql_table('skin_desc'), sql_real_escape_string($name)); + return quickQuery($query) > 0; } /** + * Skin::existsID() * Checks if a skin with a given ID exists - * @param string $id Skin ID - * @return int number of skins with the given ID + * * @static + * @param string $id Skin ID + * @return integer number of skins with the given ID */ - function existsID($id) + static public function existsID($id) { - return quickQuery('select COUNT(*) as result FROM ' . sql_table('skin_desc') . ' WHERE sdnumber=' . intval($id)) > 0; + $query = "SELECT COUNT(*) AS result FROM %s WHERE sdnumber=%d;"; + $query = sprintf($query, sql_table('skin_desc'), (integer) $id); + return quickQuery($query) > 0; } /** + * Skin::createFromName() * Returns a skin given its shortname - * @param string $name Skin shortname - * @return object SKIN + * * @static + * @param string $name Skin shortname + * @return object instance of Skin class */ - function createFromName($name) + static public function createFromName($name) { return new SKIN(SKIN::getIdFromName($name)); } /** + * Skin::getIdFromName() * Returns a skin ID given its shortname - * @param string $name Skin shortname - * @return int Skin ID + * * @static + * @param string $name Skin shortname + * @return integer Skin ID */ - function getIdFromName($name) + static public function getIdFromName($name) { - $query = 'SELECT sdnumber' - . ' FROM ' . sql_table('skin_desc') - . ' WHERE sdname="' . sql_real_escape_string($name) . '"'; + $query = "SELECT sdnumber FROM %s WHERE sdname='%s';"; + $query = sprintf($query, sql_table('skin_desc'), sql_real_escape_string($name)); $res = sql_query($query); $obj = sql_fetch_object($res); return $obj->sdnumber; } /** + * Skin::getNameFromId() * Returns a skin shortname given its ID - * @param string $name - * @return string Skin short name + * * @static + * @param string $name + * @return string Skin short name */ - function getNameFromId($id) + static public function getNameFromId($id) { - return quickQuery('SELECT sdname as result FROM ' . sql_table('skin_desc') . ' WHERE sdnumber=' . intval($id)); + $query = "SELECT sdname AS result FROM %s WHERE sdnumber=%d;"; + $query = sprintf($query, sql_table('skin_desc'), (integer) $id); + return quickQuery($query); } /** @@ -191,7 +232,6 @@ class Skin * @param String $includeMode value for nucleus_skin.sdinclude * @param String $includePrefix value for nucleus_skin.sdincpref * @return Integer ID for just inserted record - * */ function createNew($name, $desc, $type = 'text/html', $includeMode = 'normal', $includePrefix = '') { @@ -208,33 +248,40 @@ class Skin ) ); - $query = "INSERT INTO %s (sdname, sddesc, sdtype, sdincmode, sdincpref) VALUES ('%s', '%s', '%s', '%s', '%s')"; - $query = sprintf($query, sql_table('skin_desc'), sql_real_escape_string($name), sql_real_escape_string($desc), sql_real_escape_string($type), sql_real_escape_string($includeMode), sql_real_escape_string($includePrefix)); + $query = "INSERT INTO %s (sdname, sddesc, sdtype, sdincmode, sdincpref) VALUES ('%s', '%s', '%s', '%s', '%s');"; + $sdname = sql_real_escape_string($name); + $sddesc = sql_real_escape_string($desc); + $sdtype = sql_real_escape_string($type); + $sdincmode = sql_real_escape_string($includeMode); + $sdincpref = sql_real_escape_string($includePrefix); + $query = sprintf($query, sql_table('skin_desc'), $sdname, $sddesc, $sdtype, $sdincmode, $sdincpref); sql_query($query); $newid = sql_insert_id(); $manager->notify( 'PostAddSkin', array( - 'skinid' => $newid, - 'name' => $name, - 'description' => $desc, - 'type' => $type, - 'includeMode' => $includeMode, - 'includePrefix' => $includePrefix + 'skinid' => $newid, + 'name' => $name, + 'description' => $desc, + 'type' => $type, + 'includeMode' => $includeMode, + 'includePrefix' => $includePrefix ) ); return $newid; } /** + * Skin::parse() * Parse a SKIN * - * @param string $type + * @param string $type + * @return void */ - function parse($type) + public function parse($type) { - global $manager, $CONF; + global $currentSkinName, $manager, $CONF; $manager->notify('InitSkinParse',array('skin' => &$this, 'type' => $type)); @@ -242,9 +289,7 @@ class Skin sendContentType($this->getContentType(), 'skin'); // set skin name as global var (so plugins can access it) - global $currentSkinName; $currentSkinName = $this->getName(); - $contents = $this->getContent($type); if ( !$contents ) @@ -264,8 +309,8 @@ class Skin $manager->notify('PreSkinParse',array('skin' => &$this, 'type' => $type, 'contents' => &$contents)); // set IncludeMode properties of parser - Parser::setProperty('IncludeMode',$this->getIncludeMode()); - Parser::setProperty('IncludePrefix',$this->getIncludePrefix()); + Parser::setProperty('IncludeMode', $this->getIncludeMode()); + Parser::setProperty('IncludePrefix', $this->getIncludePrefix()); $handler = new Actions($type, $this); $parser = new Parser($actions, $handler); @@ -274,45 +319,44 @@ class Skin $parser->parse($contents); $manager->notify('PostSkinParse',array('skin' => &$this, 'type' => $type)); + return; } /** + * Skin::getContent() * Get content of the skin part from the database * - * @param $type type of the skin (e.g. index, item, search ...) + * @param string $type type of the skin (e.g. index, item, search ...) + * @return string content of scontent */ function getContent($type) { - $query = 'SELECT scontent FROM '. sql_table('skin') . " WHERE sdesc=$this->id and stype='" . sql_real_escape_string($type) . "'"; + $query = "SELECT scontent FROM %s WHERE sdesc=%d and stype='%s';"; + $query = sprintf($query, sql_table('skin'), (integer) $this->id, sql_real_escape_string($type)); $res = sql_query($query); if ( sql_num_rows($res) == 0 ) { return ''; } - else - { - return sql_result($res, 0, 0); - } + return sql_result($res, 0, 0); } /** * SKIN::update() * Updates the contents for one part of the skin in the database * - * @param $type type of the skin part (e.g. index, item, search ...) - * @param $content new content for this skin part - * @return Void + * @param string $type type of the skin part (e.g. index, item, search ...) + * @param string $content new content for this skin part + * @return void * */ function update($type, $content) { global $manager; - $skinid = $this->id; - - $query = "SELECT sdesc FROM %s WHERE stype='%s' and sdesc=%d"; - $query = sprintf($query, sql_table('skin'), sql_real_escape_string($type), (integer) $skinid); + $query = "SELECT sdesc FROM %s WHERE stype='%s' and sdesc=%d;"; + $query = sprintf($query, sql_table('skin'), sql_real_escape_string($type), (integer) $this->id); $res = sql_query($query); $skintypeexists = sql_fetch_object($res); @@ -324,31 +368,31 @@ class Skin $manager->notify( 'PreUpdateSkinPart', array( - 'skinid' => $skinid, + 'skinid' => $this->id, 'type' => $type, 'content' => &$content ) ); } - else if( $skintypevalue && (!$skintypeexists) ) + else if( $skintypevalue && !$skintypeexists ) { // PreAddSkinPart event $manager->notify( 'PreAddSkinPart', array( - 'skinid' => $skinid, + 'skinid' => $this->id, 'type' => $type, 'content' => &$content ) ); } - else if( (!$skintypevalue) && $skintypeexists ) + else if( !$skintypevalue && $skintypeexists ) { // PreDeleteSkinPart event $manager->notify( 'PreDeleteSkinPart', array( - 'skinid' => $skinid, + 'skinid' => $this->id, 'type' => $type ) ); @@ -356,14 +400,14 @@ class Skin // delete old thingie $query = "DELETE FROM %s WHERE stype='%s' and sdesc=%d"; - $query = sprintf($query, sql_table('skin'), sql_real_escape_string($type), (integer) $skinid); + $query = sprintf($query, sql_table('skin'), sql_real_escape_string($type), (integer) $this->id); sql_query($query); // write new thingie if ( $content ) { $query = "INSERT INTO %s (scontent, stype, sdesc) VALUE ('%s', '%s', %d)"; - $query = sprintf($query, sql_table('skin'), sql_real_escape_string($content), sql_real_escape_string($type), (integer) $skinid); + $query = sprintf($query, sql_table('skin'), sql_real_escape_string($content), sql_real_escape_string($type), (integer) $this->id); sql_query($query); } @@ -373,9 +417,9 @@ class Skin $manager->notify( 'PostUpdateSkinPart', array( - 'skinid' => $skinid, - 'type' => $type, - 'content' => &$content + 'skinid' => $this->id, + 'type' => $type, + 'content' => &$content ) ); } @@ -385,9 +429,9 @@ class Skin $manager->notify( 'PostAddSkinPart', array( - 'skinid' => $skinid, - 'type' => $type, - 'content' => &$content + 'skinid' => $this->id, + 'type' => $type, + 'content' => &$content ) ); } @@ -397,8 +441,8 @@ class Skin $manager->notify( 'PostDeleteSkinPart', array( - 'skinid' => $skinid, - 'type' => $type + 'skinid' => $this->id, + 'type' => $type ) ); } @@ -406,104 +450,128 @@ class Skin } /** + * Skin::deleteAllParts() * Deletes all skin parts from the database + * + * @param void + * @return void */ function deleteAllParts() { - sql_query('DELETE FROM ' . sql_table('skin') . ' WHERE sdesc=' . $this->getID()); + $query = "DELETE FROM %s WHERE sdesc=%d;"; + $query = sprintf($query, sql_table('skin'), (integer) $this->id); + sql_query($query); } - + /** + * Skin::updateGeneralInfo() * Updates the general information about the skin + * + * @param string $name name of the skin + * @param string $desc description of the skin + * @param string $type type of the skin + * @param string $includeMode include mode of the skin + * @param string $includePrefix include prefix of the skin + * @return void */ function updateGeneralInfo($name, $desc, $type = 'text/html', $includeMode = 'normal', $includePrefix = '') { - $query = 'UPDATE '.sql_table('skin_desc').' SET' - . " sdname='" . sql_real_escape_string($name) . "'," - . " sddesc='" . sql_real_escape_string($desc) . "'," - . " sdtype='" . sql_real_escape_string($type) . "'," - . " sdincmode='" . sql_real_escape_string($includeMode) . "'," - . " sdincpref='" . sql_real_escape_string($includePrefix) . "'" - . " WHERE sdnumber=" . $this->getID(); + $name = sql_real_escape_string($name); + $desc = sql_real_escape_string($desc); + $type = sql_real_escape_string($type); + $includeMode = sql_real_escape_string($includeMode); + $includePrefix = sql_real_escape_string($includePrefix); + + $query ="UPDATE %s SET sdname='', sddesc='%s', sdtype='%s', sdincmode='%s', sdincpref='%s' WHERE sdnumber=%d:"; + $query = sprintf($query, $name, $desc, $type, $includeMode, $includePrefix, (integer) $this->id); + sql_query($query); + return; } /** + * Skin::getFriendlyNames() * Get an array with the names of possible skin parts * Used to show all possible parts of a skin in the administration backend * - * static: returns an array of friendly names + * @param void + * @param array type of the skin */ - function getFriendlyNames() + static public function getFriendlyNames() { $skintypes = array( - 'index' => _SKIN_PART_MAIN, - 'item' => _SKIN_PART_ITEM, - 'archivelist' => _SKIN_PART_ALIST, - 'archive' => _SKIN_PART_ARCHIVE, - 'search' => _SKIN_PART_SEARCH, - 'error' => _SKIN_PART_ERROR, - 'member' => _SKIN_PART_MEMBER, - 'imagepopup' => _SKIN_PART_POPUP + 'index' => _SKIN_PART_MAIN, + 'item' => _SKIN_PART_ITEM, + 'archivelist' => _SKIN_PART_ALIST, + 'archive' => _SKIN_PART_ARCHIVE, + 'search' => _SKIN_PART_SEARCH, + 'error' => _SKIN_PART_ERROR, + 'member' => _SKIN_PART_MEMBER, + 'imagepopup' => _SKIN_PART_POPUP ); - $query = "SELECT stype FROM " . sql_table('skin') . " WHERE stype NOT IN ('index', 'item', 'error', 'search', 'archive', 'archivelist', 'imagepopup', 'member')"; + $query = "SELECT stype FROM " . sql_table('skin') + . " WHERE stype NOT IN ('index', 'item', 'error', 'search', 'archive', 'archivelist', 'imagepopup', 'member')"; $res = sql_query($query); while ( $row = sql_fetch_array($res) ) { + /* TODO: ucfirst() depends on the current locale */ $skintypes[strtolower($row['stype'])] = ucfirst($row['stype']); } return $skintypes; } - + /** + * Skin::getAllowedActionsForType() * Get the allowed actions for a skin type * returns an array with the allowed actions * - * @param $type type of the skin (e.g. index, item, search ...) + * @param string $type type of the skin (e.g. index, item, search ...) + * @return array allowed action types */ function getAllowedActionsForType($type) { global $blogid; // some actions that can be performed at any time, from anywhere - $defaultActions = array('otherblog', - 'plugin', - 'version', - 'nucleusbutton', - 'include', - 'phpinclude', - 'parsedinclude', - 'loginform', - 'sitevar', - 'otherarchivelist', - 'otherarchivedaylist', - 'otherarchiveyearlist', - 'self', - 'adminurl', - 'todaylink', - 'archivelink', - 'member', - 'category', - 'searchform', - 'referer', - 'skinname', - 'skinfile', - 'set', - 'if', - 'else', - 'endif', - 'elseif', - 'ifnot', - 'elseifnot', - 'charset', - 'bloglist', - 'addlink', - 'addpopupcode', - 'sticky', - // deprecated (Nucleus v2.0) - 'ifcat' - ); + $defaultActions = array( + 'otherblog', + 'plugin', + 'version', + 'nucleusbutton', + 'include', + 'phpinclude', + 'parsedinclude', + 'loginform', + 'sitevar', + 'otherarchivelist', + 'otherarchivedaylist', + 'otherarchiveyearlist', + 'self', + 'adminurl', + 'todaylink', + 'archivelink', + 'member', + 'category', + 'searchform', + 'referer', + 'skinname', + 'skinfile', + 'set', + 'if', + 'else', + 'endif', + 'elseif', + 'ifnot', + 'elseifnot', + 'charset', + 'bloglist', + 'addlink', + 'addpopupcode', + 'sticky', + // deprecated (Nucleus v2.0) + /* TODO: remove this */ + 'ifcat'); // extra actions specific for a certain skin type $extraActions = array(); @@ -511,98 +579,105 @@ class Skin switch ( $type ) { case 'index': - $extraActions = array('blog', - 'blogsetting', - 'preview', - 'additemform', - 'categorylist', - 'archivelist', - 'archivedaylist', - 'archiveyearlist', - 'nextlink', - 'prevlink' - ); + $extraActions = array( + 'blog', + 'blogsetting', + 'preview', + 'additemform', + 'categorylist', + 'archivelist', + 'archivedaylist', + 'archiveyearlist', + 'nextlink', + 'prevlink' + ); break; case 'archive': - $extraActions = array('blog', - 'archive', - 'otherarchive', - 'categorylist', - 'archivelist', - 'archivedaylist', - 'archiveyearlist', - 'blogsetting', - 'archivedate', - 'nextarchive', - 'prevarchive', - 'nextlink', - 'prevlink', - 'archivetype' + $extraActions = array( + 'blog', + 'archive', + 'otherarchive', + 'categorylist', + 'archivelist', + 'archivedaylist', + 'archiveyearlist', + 'blogsetting', + 'archivedate', + 'nextarchive', + 'prevarchive', + 'nextlink', + 'prevlink', + 'archivetype' ); break; case 'archivelist': - $extraActions = array('blog', - 'archivelist', - 'archivedaylist', - 'archiveyearlist', - 'categorylist', - 'blogsetting', - ); + $extraActions = array( + 'blog', + 'archivelist', + 'archivedaylist', + 'archiveyearlist', + 'categorylist', + 'blogsetting' + ); break; case 'search': - $extraActions = array('blog', - 'archivelist', - 'archivedaylist', - 'archiveyearlist', - 'categorylist', - 'searchresults', - 'othersearchresults', - 'blogsetting', - 'query', - 'nextlink', - 'prevlink' - ); + $extraActions = array( + 'blog', + 'archivelist', + 'archivedaylist', + 'archiveyearlist', + 'categorylist', + 'searchresults', + 'othersearchresults', + 'blogsetting', + 'query', + 'nextlink', + 'prevlink' + ); break; case 'imagepopup': - $extraActions = array('image', - // deprecated (Nucleus v2.0) - 'imagetext', - ); + $extraActions = array( + 'image', + // deprecated (Nucleus v2.0) + /* TODO: remove this */ + 'imagetext' + ); break; case 'member': $extraActions = array( - 'membermailform', - 'blogsetting', - 'nucleusbutton', - 'categorylist' + 'membermailform', + 'blogsetting', + 'nucleusbutton', + 'categorylist' ); break; case 'item': - $extraActions = array('blog', - 'item', - 'comments', - 'commentform', - 'vars', - 'blogsetting', - 'nextitem', - 'previtem', - 'nextlink', - 'prevlink', - 'nextitemtitle', - 'previtemtitle', - 'categorylist', - 'archivelist', - 'archivedaylist', - 'archiveyearlist', - 'itemtitle', - 'itemid', - 'itemlink', - ); + $extraActions = array( + 'blog', + 'item', + 'comments', + 'commentform', + 'vars', + 'blogsetting', + 'nextitem', + 'previtem', + 'nextlink', + 'prevlink', + 'nextitemtitle', + 'previtemtitle', + 'categorylist', + 'archivelist', + 'archivedaylist', + 'archiveyearlist', + 'itemtitle', + 'itemid', + 'itemlink' + ); break; case 'error': $extraActions = array( - 'errormessage', - 'categorylist' + 'errormessage', + 'categorylist' ); break; default: -- 2.11.0