1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 

<?php
/**
 * icms_ipf_Metagen
 *
 * Containing the class to manage meta informations of icms_ipf_Object
 *
 * @copyright   The ImpressCMS Project http://www.impresscms.org/
 * @license     http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU General Public License (GPL)
 * @category    ICMS
 * @package     Ipf
 * @since       1.1
 * @author      marcan <marcan@impresscms.org>
 * @version     SVN: $Id: Metagen.php 12248 2013-08-09 08:56:21Z fiammy $
 */

defined("ICMS_ROOT_PATH") or die("ImpressCMS root path not defined");

/**
 * Generates META tags
 * @category    ICMS
 * @package     Ipf
 * @todo        Properly set visibility of variables - in version 2.0
 */
class icms_ipf_Metagen {
    /** @var object */
    public $_myts;

    /** @var string */
    public $_title;

    /** @var string */
    public $_original_title;

    /** @var string */
    public $_keywords;

    /** @var string */
    public $_meta_description;

    /** @var string */
    public $_categoryPath;

    /** @var string */
    public $_description;

    /** @var int */
    public $_minChar = 4;

    /**
     * Constructor for icms_ipf_Metagen
     *
     * @param string $title Page title
     * @param string $keywords List of meta keywords
     * @param string $description Meta description
     * @param string $categoryPath
     *
     */
    public function __construct($title, $keywords = false, $description = false, $categoryPath = false) {
        $this->_myts = icms_core_Textsanitizer::GetInstance();
        $this->setCategoryPath($categoryPath);
        $this->setTitle($title);
        $this->setDescription($description);

        if (!$keywords) {
            $keywords = $this->createMetaKeywords();
        }

        /*      $myts = icms_core_Textsanitizer::getInstance();
         if (method_exists($myts, 'formatForML')) {
            $keywords = $myts->formatForML($keywords);
            $description = $myts->formatForML($description);
            }
            */
        $this->setKeywords($keywords);

    }

    /**
     * Return true if the string is length > 0
     *
     * @author psylove
     *
     * @var string String to test
     * @return boolean
     */
    public function emptyString($var) {
        return strlen($var) > 0;
    }

    /**
     * Create a title for the short_url field of an article
     *
     * @author psylove
     *
     * @var string $title title of the article
     * @var string $withExt do we add an html extension or not
     * @return string sort_url for the article
     */
    public function generateSeoTitle($title='', $withExt = true) {
        // Transformation de la chaine en minuscule
        // Codage de la chaine afin d'�viter les erreurs 500 en cas de caract�res impr�vus
        $title   = rawurlencode(strtolower($title));

        // Transformation des ponctuations
        //                 Tab     Space      !        "        #        %        &        '        (        )        ,        /        :        ;        <        =        >        ?        @        [        \        ]        ^        {        |        }        ~       .
        $pattern = array("/%09/", "/%20/", "/%21/", "/%22/", "/%23/", "/%25/", "/%26/", "/%27/", "/%28/", "/%29/", "/%2C/", "/%2F/", "/%3A/", "/%3B/", "/%3C/", "/%3D/", "/%3E/", "/%3F/", "/%40/", "/%5B/", "/%5C/", "/%5D/", "/%5E/", "/%7B/", "/%7C/", "/%7D/", "/%7E/", "/\./");
        $rep_pat = array(  "-"  ,   "-"  ,   "-"  ,   "-"  ,   "-"  , "-100" ,   "-"  ,   "-"  ,   "-"  ,   "-"  ,   "-"  ,   "-"  ,  "-"   ,   "-"  ,   "-"  ,   "-"  ,  "-"   ,   "-"  , "-at-" ,   "-"  ,   "-"   ,  "-"  ,   "-"  ,   "-"  ,   "-"  ,   "-"  ,   "-"  ,   "-" );
        $title   = preg_replace($pattern, $rep_pat, $title);

        // Transformation des caract�res accentu�s
        //                  �        �        �        �        �        �        �        �        �        �        �        �        �        �        �        �
        $pattern = array("/%B0/", "/%E8/", "/%E9/", "/%EA/", "/%EB/", "/%E7/", "/%E0/", "/%E2/", "/%E4/", "/%EE/", "/%EF/", "/%F9/", "/%FC/", "/%FB/", "/%F4/", "/%F6/");
        $rep_pat = array(  "-"  ,   "e"  ,   "e"  ,   "e"  ,   "e"  ,   "c"  ,   "a"  ,   "a"  ,   "a"  ,   "i"  ,   "i"  ,   "u"  ,   "u"  ,   "u"  ,   "o"  ,   "o"  );
        $title   = preg_replace($pattern, $rep_pat, $title);

        $tableau = explode("-", $title); // Transforme la chaine de caract�res en tableau
        $tableau = array_filter($tableau, array($this, "emptyString")); // Supprime les chaines vides du tableau
        $title   = implode("-", $tableau); // Transforme un tableau en chaine de caract�res s�par� par un tiret

        if (strlen($title) > 0) {
            if ($withExt) {
                $title .= '.html';
            }
            return $title;
        }
        else
        return '';
    }

    /**
     *
     * @param $document
     * @return string Converted text
     */
    public function html2text($document) {
        return icms_html2text($document);
    }

    /**
     * Sets the title property
     * @param string $title
     *
     */
    public function setTitle($title) {
        global $icmsModuleConfig;
        $this->_title = $this->html2text($title);
        $this->_title = $this->purifyText($this->_title);
        $this->_original_title = $this->_title;

        $moduleName = is_object(icms::$module) ? icms::$module->getVar('name') : "";

        $titleTag = array();

        $show_mod_name_breadcrumb = isset($icmsModuleConfig['show_mod_name_breadcrumb'])
                ? $icmsModuleConfig['show_mod_name_breadcrumb']
                : true;

        if ($moduleName && $show_mod_name_breadcrumb) {
            $titleTag['module'] = $moduleName;
        }

        if (isset($this->_title) && ($this->_title != '') && (strtoupper($this->_title) != strtoupper($moduleName))) {
            $titleTag['title'] = $this->_title;
        }

        if (isset($this->_categoryPath) && ($this->_categoryPath != '')) {
            $titleTag['category'] = $this->_categoryPath;
        }

        $ret = isset($titleTag['title']) ? $titleTag['title'] : '';

        if (isset($titleTag['category']) && $titleTag['category'] != '') {
            if ($ret != '') {
                $ret .= ' - ';
            }
            $ret .= $titleTag['category'];
        }
        if (isset($titleTag['module']) && $titleTag['module'] != '') {
            if ($ret != '') {
                $ret .= ' - ';
            }
            $ret .= $titleTag['module'];
        }
        $this->_title = $ret;
    }

    /**
     * Sets the keyword property
     *
     * @param string $keywords
     *
     */
    public function setKeywords($keywords) {
        $this->_keywords = $keywords;
    }

    /**
     * Sets the categoryPath property
     *
     * @param string $categoryPath
     *
     */
    public function setCategoryPath($categoryPath) {
        $categoryPath = $this->html2text($categoryPath);
        $this->_categoryPath = $categoryPath;
    }

    /**
     * Sets the description property
     * @param string $description
     *
     */
    public function setDescription($description) {
        if (!$description) {
            global $icmsModuleConfig;
            if (isset($icmsModuleConfig['module_meta_description'])) {
                $description = $icmsModuleConfig['module_meta_description'];
            }
        }

        $description = $this->html2text($description);
        $description = $this->purifyText($description);

        $description = preg_replace("/([^\r\n])\r\n([^\r\n])/", "\\1 \\2", $description);
        $description = preg_replace("/[\r\n]*\r\n[\r\n]*/", "\r\n\r\n", $description);
        $description = preg_replace("/[ ]* [ ]*/", ' ', $description);
        $description = icms_core_DataFilter::stripSlashesGPC($description);

        $this->_description = $description;
        $this->_meta_description = $this->createMetaDescription();

    }

    /**
     * An empty function
     *
     */
    public function createTitleTag() {

    }

    /**
     * Cleans the provided text, a wrapper for icms_purifyText
     * @see icms_purifyText
     * @param string $text Text to be cleaned
     * @param boolean $keyword Whether the provided string is a keyword, or not
     * @return string The purified text
     */
    public function purifyText($text, $keyword = false) {
        return icms_purifyText($text, $keyword);
    }

    /**
     * Creates a meta description
     * @param int $maxWords Maximum number of words for the description
     * @return string
     */
    public function createMetaDescription($maxWords = 100) {
        $words = array();
        $words = explode(" ", $this->_description);

        // Only keep $maxWords words
        $newWords = array();
        $i = 0;

        while ($i < $maxWords-1 && $i < count($words)) {
            $newWords[] = $words[$i];
            $i++;
        }
        $ret = implode(' ', $newWords);

        return $ret;
    }

    /**
     * Generates a list of keywords from the provided text
     * @param string $text Text to parse
     * @param int $minChar Minimum word length for the keywords
     * @return array An array of keywords
     */
    public function findMetaKeywords($text, $minChar) {
        $keywords = array();

        $text = $this->purifyText($text);
        $text = $this->html2text($text);

        $text = preg_replace("/([^\r\n])\r\n([^\r\n])/", "\\1 \\2", $text);
        $text = preg_replace("/[\r\n]*\r\n[\r\n]*/", "\r\n\r\n", $text);
        $text = preg_replace("/[ ]* [ ]*/", ' ', $text);
        $text = icms_core_DataFilter::stripSlashesGPC($text);

        $originalKeywords = preg_split ('/[^a-zA-Z\'"-]+/', $text, -1, PREG_SPLIT_NO_EMPTY);

        foreach ($originalKeywords as $originalKeyword) {
            $secondRoundKeywords = explode("'", $originalKeyword);
            foreach ( $secondRoundKeywords as $secondRoundKeyword) {
                if (strlen($secondRoundKeyword) >= $minChar) {
                    if (!in_array($secondRoundKeyword, $keywords)) {
                        $keywords[] = trim($secondRoundKeyword);
                    }
                }
            }
        }
        return $keywords;
    }

    /**
     * Creates a string of keywords
     * @return string
     */
    public function createMetaKeywords() {
        global $icmsModuleConfig;
        $keywords = $this->findMetaKeywords($this->_original_title . " " . $this->_description, $this->_minChar);
        if (isset($icmsModuleConfig) && isset($icmsModuleConfig['moduleMetaKeywords']) && $icmsModuleConfig['moduleMetaKeywords'] != '') {
            $moduleKeywords = explode(",", $icmsModuleConfig['moduleMetaKeywords']);
            $keywords = array_merge($keywords, $moduleKeywords);
        }

        /* Commenting this out as it may cause problem on ImpressCMS ML websites
         $return_keywords = array();

         // Cleaning for duplicate keywords
         foreach ($keywords as $keyword) {
            if (!in_array($keyword, $keywords)) {
            $return_keywords[] = trim($keyword);
            }
            }*/

        // Only take the first 90 keywords
        $newKeywords = array();
        $i = 0;
        while ($i < 90 - 1 && isset($keywords[$i])) {
            $newKeywords[] = $keywords[$i];
            $i++;
        }
        $ret = implode(', ', $newKeywords);

        return $ret;
    }

    /**
     * An empty function
     *
     */
    public function autoBuildMeta_keywords() {

    }

    /**
     * Generates keywords, description and title, setting the associated properties
     *
     */
    public function buildAutoMetaTags() {
        global $icmsModule, $icmsModuleConfig;

        $this->_keywords = $this->createMetaKeywords();
        $this->_meta_description = $this->createMetaDescription();
        $this->_title = $this->createTitleTag();

    }

    /**
     * Assigns the meta tags to the template
     *
     */
    public function createMetaTags() {
        global $xoopsTpl, $xoTheme;
        $this->_keywords = preg_replace("(<!--.*?-->)", '', $this->_keywords); // stops html comments appearing in meta key

        if (is_object($xoTheme)) {
            $xoTheme->addMeta('meta', 'keywords', $this->_keywords);
            $xoTheme->addMeta('meta', 'description', $this->_description);
            $xoTheme->addMeta('meta', 'title', $this->_title);
        } else {
            $xoopsTpl->assign('xoops_meta_keywords', $this->_keywords);
            $xoopsTpl->assign('xoops_meta_description', $this->_description);
        }
        $xoopsTpl->assign('icms_pagetitle', $this->_title);
    }
}