├── composer.json ├── SeoViewBehavior.php ├── README.md ├── SeoModelBehavior.php └── LICENSE /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "demi/seo", 3 | "description": "Library for working with SEO parameters of models", 4 | "keywords": ["seo", "yii2"], 5 | "homepage": "https://github.com/demisang/yii2-seo#readme", 6 | "type": "yii2-extension", 7 | "license": "GPL-3.0-or-later", 8 | "authors": [ 9 | { 10 | "name": "Ivan Orlov", 11 | "email": "gnasimed@gmail.com", 12 | "homepage": "https://orlov.io/", 13 | "role": "Creator" 14 | } 15 | ], 16 | "support": { 17 | "issues": "https://github.com/demisang/yii2-seo/issues", 18 | "source": "https://github.com/demisang/yii2-seo" 19 | }, 20 | "require": { 21 | "php": ">=5.4.0", 22 | "yiisoft/yii2": "*" 23 | }, 24 | "autoload": { 25 | "psr-4": { 26 | "demi\\seo\\": "" 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /SeoViewBehavior.php: -------------------------------------------------------------------------------- 1 | 7 | */ 8 | 9 | namespace demi\seo; 10 | 11 | use Yii; 12 | use yii\base\Behavior; 13 | use yii\web\View; 14 | use yii\helpers\Html; 15 | 16 | /** 17 | * Manage page seo-params 18 | * 19 | * @property View $owner 20 | */ 21 | class SeoViewBehavior extends Behavior 22 | { 23 | /** 24 | * tag content template 25 | * 26 | * @var string 27 | */ 28 | public $titleTemplate = '{title} - {appName}'; 29 | /** 30 | * <meta name="description"> tag content value template 31 | * 32 | * @var string 33 | */ 34 | public $descriptionTemplate = '{description}'; 35 | /** 36 | * <meta name="keywords"> tag content value template 37 | * 38 | * @var string 39 | */ 40 | public $keywordsTemplate = '{keywords}'; 41 | 42 | protected $_page_title = ''; 43 | protected $_meta_description = ''; 44 | protected $_meta_keywords = ''; 45 | protected $_noIndex = false; 46 | 47 | public function events() 48 | { 49 | return [ 50 | // ActiveRecord::EVENT_BEFORE_VALIDATE => 'beforeValidate', 51 | // ActiveRecord::EVENT_BEFORE_INSERT => 'beforeSave', 52 | // ActiveRecord::EVENT_BEFORE_UPDATE => 'beforeSave', 53 | // ActiveRecord::EVENT_BEFORE_DELETE => 'beforeDelete', 54 | // ActiveRecord::EVENT_AFTER_FIND => 'afterFind', 55 | ]; 56 | } 57 | 58 | /** 59 | * Set page meta 60 | * 61 | * @param string|SeoModelBehavior $title 1) array: 62 | * ["title"=>"Page Title", "desc"=>"Page Descriptions", "keys"=>"Page, Keywords"] 63 | * 2) SeoModelBehavior 64 | * 3) Page title string 65 | * @param string $desc Meta description string 66 | * @param string|string[] $keys Meta keywords: string or keywords array 67 | * 68 | * @return static 69 | */ 70 | public function setSeoData($title, $desc = '', $keys = '') 71 | { 72 | $data = $title; 73 | if ($title instanceof SeoModelBehavior) { 74 | // Get data from model with SeoModelBehavior 75 | $meta = $title->getSeoData(); 76 | $data = [ 77 | 'title' => $meta[SeoModelBehavior::TITLE_KEY], 78 | 'desc' => $meta[SeoModelBehavior::DESC_KEY], 79 | 'keys' => $meta[SeoModelBehavior::KEYS_KEY], 80 | ]; 81 | } elseif (is_string($title)) { 82 | $data = array( 83 | 'title' => $title, 84 | 'desc' => $desc, 85 | 'keys' => !is_array($keys) ? $keys : implode(', ', $keys), 86 | ); 87 | } 88 | if (isset($data['title'])) { 89 | $this->_page_title = $this->owner->title = $this->normalizeStr($data['title']); 90 | } 91 | if (isset($data['desc'])) { 92 | $this->_meta_description = $this->normalizeStr($data['desc']); 93 | } 94 | if (isset($data['keys'])) { 95 | $this->_meta_keywords = $this->normalizeStr($data['keys']); 96 | } 97 | 98 | return $this; 99 | } 100 | 101 | /** 102 | * Print tags: 103 | * <title> 104 | * 105 | * Register meta tags: 106 | * <meta name="description"> 107 | * <meta name="keywords"> 108 | * 109 | * and optional: 110 | * <meta name="robots" content="noindex, [follow|nofollow]"> 111 | */ 112 | public function renderMetaTags() 113 | { 114 | $view = $this->owner; 115 | 116 | if ($this->_page_title) { 117 | // If title set - use it 118 | $title = $this->_page_title; 119 | } elseif ($view->title) { 120 | // Use default Yii title value 121 | $title = $view->title; 122 | } 123 | 124 | if (!empty($title)) { 125 | // Make title by template 126 | $title = strtr($this->titleTemplate, [ 127 | '{title}' => $title, 128 | '{appName}' => Yii::$app->name, 129 | ]); 130 | } else { 131 | // Otherwise by default use App name for title 132 | $title = Yii::$app->name; 133 | } 134 | 135 | // Print <title> tag 136 | echo '<title>' . Html::encode($this->normalizeStr($title)) . '' . PHP_EOL; 137 | 138 | // Register tag 139 | if (!empty($this->_meta_description)) { 140 | $description = str_replace('{description}', $this->_meta_description, $this->descriptionTemplate); 141 | $view->registerMetaTag(['name' => 'description', 'content' => Html::encode($this->normalizeStr($description))]); 142 | } 143 | 144 | // Register tag 145 | if (!empty($this->_meta_keywords)) { 146 | $keywords = str_replace('{keywords}', $this->_meta_keywords, $this->keywordsTemplate); 147 | $view->registerMetaTag(['name' => 'keywords', 'content' => Html::encode($this->normalizeStr($keywords))]); 148 | } 149 | 150 | // Register tag 151 | if (!empty($this->_noIndex)) { 152 | $view->registerMetaTag(['name' => 'robots', 'content' => $this->_noIndex]); 153 | } 154 | } 155 | 156 | /** 157 | * Setup noindex tag for current page 158 | * 159 | * @param boolean $follow Allow search engine links following? 160 | */ 161 | public function noIndex($follow = true) 162 | { 163 | $content = 'noindex, ' . ($follow ? 'follow' : 'nofollow'); 164 | 165 | $this->_noIndex = $content; 166 | } 167 | 168 | /** 169 | * Page title 170 | * 171 | * @return string 172 | */ 173 | public function getTitle() 174 | { 175 | return $this->_page_title; 176 | } 177 | 178 | /** 179 | * Page description 180 | * 181 | * @return string 182 | */ 183 | public function getDescription() 184 | { 185 | return $this->_meta_description; 186 | } 187 | 188 | /** 189 | * Page keywords 190 | * 191 | * @return string 192 | */ 193 | public function getKeywords() 194 | { 195 | return $this->_meta_keywords; 196 | } 197 | 198 | /** 199 | * String normalizer 200 | * 201 | * @param string $str 202 | * 203 | * @return string 204 | */ 205 | protected function normalizeStr($str) 206 | { 207 | // Remove html-tags 208 | $str = strip_tags($str); 209 | // Replace 2+ spaces to one 210 | $str = trim(preg_replace('/[\s]+/is', ' ', $str)); 211 | 212 | return $str; 213 | } 214 | } 215 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | yii2-seo 2 | ======== 3 | Library for working with SEO parameters of models 4 | 5 | How it works: 6 | ------------- 7 | You add 2 fields to you model: 8 | - `seo_url` VARCHAR: it is unique model name, example: `http://example.com/post/`. 9 | - `seo_meta` TEXT: it is serialized array: `['title' => 'Post title', 'desc' => 'Post description', 'keys' => 'Post title, other keywords...']`. 10 | 11 | This behavior help you with: 12 | - Generate `seo_url` from model title considering your unique-conditions. 13 | - Internationalization for `seo_meta`. 14 | - Get model view url by simple call `$model->viewUrl`. (return relative url `/post/my-first` and even `/cat1/cat2/awesome-post` is possible). 15 | - Output model seo fields(internationalized) to html: ``, `<meta name="description">` and `<meta name="keywords">` 16 | - Form fields for `seo_url` and all `seo_meta` and internationalizations fields if needed. 17 | - You can(must) configure `seo_meta` fields generator, for example: keywords is: `<postTitle>, key1, key2, <postTags>, ...`. 18 | 19 | Examples of generated `seo_url` for some cases: 20 | - `http://example.com/first-category/awesome-post` - post1, cat1, `seo_url` is `awesome-post` 21 | - `http://example.com/other-category/awesome-post` - post2, cat2, `seo_url` is `awesome-post` also possible 22 | - `http://example.com/first-category/awesome-post_` - post3, cat1, `seo_url` is `awesome-post_` (add underscore at end if name in post category already used) 23 | 24 | Installation 25 | ------------ 26 | Run 27 | ```code 28 | composer require "demi/seo" "~1.0" 29 | ``` 30 | 31 | Configuration 32 | ------------- 33 | Each view should have access to `demi\seo\SeoViewBehavior` methods. 34 | So configure `/frontend/config/main.php`: 35 | ```php 36 | return [ 37 | 'components' => [ 38 | 'view' => [ 39 | 'as seo' => [ 40 | 'class' => 'demi\seo\SeoViewBehavior', 41 | // options by default: 42 | 'titleTemplate' => '{title} - {appName}', 43 | 'descriptionTemplate' => '{description}', 44 | 'keywordsTemplate' => '{keywords}', 45 | ] 46 | ], 47 | ], 48 | ]; 49 | ``` 50 | 51 | In model file add seo model behavior: 52 | ```php 53 | <?php 54 | 55 | public function behaviors() 56 | { 57 | return [ 58 | 'seo' => [ 59 | 'class' => 'demi\seo\SeoModelBehavior', 60 | 'seoConfig' => [ 61 | 'urlField' => 'seo_url', 62 | 'metaField' => 'seo_meta', 63 | // attribute name or anonymous function 64 | 'urlProduceField' => 'title', 65 | // attribute name or anonymous function 66 | 'titleProduceFunc' => 'title', 67 | // attribute name or anonymous function 68 | 'descriptionProduceFunc' => 'short_desc', 69 | // attribute name or anonymous function 70 | 'keysProduceFunc' => static function (self $model) { 71 | return $model->title . ', tag1, tag2'; 72 | }, 73 | // when user can manage model seo-fields (anonymous function possible) 74 | 'clientChange' => Yii::$app->has('user') && Yii::$app->user->can(User::ROLE_ADMIN), 75 | // param for Url::to(<viewRoute>) 76 | 'viewRoute' => '/post/view', 77 | // param for Url::to(<viewRoute>, ['title' => $model->seo_url]) 78 | 'linkTitleParamName' => 'title', 79 | // only anon-function returns array of additional link params with values 80 | 'additionalLinkParams' => static function (self $model) { 81 | // Url::to(<viewRoute>, ['title' => $model->seo_url, 'category' => $model->category->seo_url]) 82 | return ['category' => $model->category->seo_url]; 83 | }, 84 | // if you model have some unique condition 85 | 'uniqueUrlFilter' => function (\yii\db\ActiveQuery $query) { 86 | $query->andWhere(['category_id' => $this->category_id]); 87 | }, 88 | // if array - seo_meta will have possible to internationalization 89 | 'languages' => 'en', 90 | // Optional. All controller actions will added to stop-list for seo_url value. 91 | // For example: if you create model with seo_url = 'delete' you can't open model by url '/post/delete', 92 | // if this option enabled, then seo_url will be 'delete_' and url: '/post/delete_' 93 | 'controllerClassName' => '\frontend\controllers\PostController', 94 | // @see [\demi\seo\SeoModelBehavior] for more properties 95 | ], 96 | ], 97 | ]; 98 | } 99 | ``` 100 | 101 | PHPdoc for model: 102 | ```php 103 | /** 104 | * @property-read array $seoData 105 | * @method array getSeoData($lang = null) Metadata for this model 106 | * @method \demi\seo\SeoModelBehavior getSeoBehavior() 107 | * @property-read array $viewUrl 108 | * @method array getViewUrl() URL to material view page 109 | * @property-read array $absoluteViewUrl 110 | * @method array getAbsoluteViewUrl() Absolute URL to material view page 111 | */ 112 | ``` 113 | Change `/frontend/views/layouts/main.php`: 114 | ```php 115 | <?php 116 | /* @var $this \yii\web\View|\demi\seo\SeoViewBehavior */ 117 | ?> 118 | <head> 119 | <!-- Replace default <title> tag --> 120 | <title><?= Html::encode($this->title) ?> 121 | 122 | renderMetaTags(); ?> 123 | ... 124 | 125 | ``` 126 | 127 | Usage 128 | ----- 129 | In "view.php" file for model: 130 | ```php 131 | // set SEO:meta data for current page 132 | $this->setSeoData($model->getSeoBehavior()); 133 | 134 | // Helper: set tag for "no index" (and optional "no follow") for current page 135 | $this->noIndex($and_no_follow_bool); 136 | ``` 137 | or in controller: 138 | ```php 139 | Yii::$app->view->setSeoData($model->getSeoBehavior()); 140 | Yii::$app->view->noIndex($and_no_follow_bool); 141 | ``` 142 | 143 | Simple url rules example in '/frontend/config/main.php': 144 | ```php 145 | 'urlManager' => [ 146 | 'enablePrettyUrl' => true, 147 | 'showScriptName' => false, 148 | 'rules' => [ 149 | 'post/' => 'post/', 150 | 'post/' => 'post/view', 151 | ], 152 | ], 153 | ``` 154 | and change `/frontend/controllers/PostController.php`: 155 | ```php 156 | public function actionView($title) 157 | { 158 | $model = Post::find()->where(['seo_url' => $title])->one(); 159 | if (!$model) { 160 | throw new NotFoundHttpException('Post not found'); 161 | } 162 | 163 | return $this->render('view', [ 164 | 'model' => $model, 165 | ]); 166 | } 167 | 168 | // And in actionCreate() and actionUpdate() change 169 | return $this->redirect(['view', 'id' => $model->id]); 170 | // to 171 | return $this->redirect($model->viewUrl); 172 | ``` 173 | 174 | Get link to model view page. Based on behavior config values: `viewRoute` and `additionalLinkParams` 175 | ```php 176 | // return url to material view page: '/post/super-post' 177 | $url = $model->getViewUrl(); 178 | $url = $model->viewUrl; 179 | 180 | // return absolute url to material view page: 'http://example.com/post/super-post' 181 | $abs_url = $model->getAbsoluteViewUrl(); 182 | $abs_url = $model->absoluteViewUrl; 183 | 184 | // Behind scene (for understanding): 185 | return Url::to([$viewRoute, ['title' => $model->$titleField] + $additionalLinkParams]], $isAbsolute); 186 | ``` 187 | 188 | Render SEO:url and SEO:meta fields in the "/frontend/views/post/_form.php" file: 189 | ```php 190 | 193 | ... 194 | renderFormSeoFields($ActiveForm_or_void); ?> 195 | ``` 196 | -------------------------------------------------------------------------------- /SeoModelBehavior.php: -------------------------------------------------------------------------------- 1 | 7 | */ 8 | 9 | namespace demi\seo; 10 | 11 | use Yii; 12 | use yii\base\Behavior; 13 | use yii\db\ActiveRecord; 14 | use yii\db\Query; 15 | use yii\helpers\Html; 16 | use yii\helpers\Url; 17 | use yii\validators\UniqueValidator; 18 | use yii\validators\Validator; 19 | use yii\widgets\ActiveForm; 20 | 21 | /** 22 | * Behavior to work with SEO meta options 23 | * 24 | * @package demi\seo 25 | * 26 | * @property ActiveRecord $owner 27 | */ 28 | class SeoModelBehavior extends Behavior 29 | { 30 | /** @var string The name of the field responsible for SEO:url */ 31 | protected $_urlField; 32 | /** @var string|callable The name of the field which will form the SEO:url, or function, 33 | * that returns the text to be processed to generate SEO:url */ 34 | protected $_urlProduceField = 'title'; 35 | /** @var string|callable PHP-expression that generates field SEO:title 36 | * example: function($model, $lang) { return $model->{"title_".$lang} } */ 37 | protected $_titleProduceFunc; 38 | /** @var string|callable PHP-expression that generates field SEO:desciption */ 39 | protected $_descriptionProduceFunc; 40 | /** @var string|callable PHP-expression that generates field SEO:keywords */ 41 | protected $_keysProduceFunc; 42 | /** 43 | * @var string The name of the resulting field, which will be stored in a serialized form of all SEO-parameters 44 | */ 45 | protected $_metaField; 46 | /** @var boolean|callable Whether to allow the user to change the SEO-data */ 47 | protected $_clientChange = true; 48 | /** @var integer The maximum length of the field SEO:url */ 49 | protected $_maxUrlLength = 70; 50 | /** @var integer The maximum length of the field Title */ 51 | protected $_maxTitleLength = 70; 52 | /** @var integer The maximum length of the field Description */ 53 | protected $_maxDescLength = 130; 54 | /** @var integer The maximum length of the field Keywords */ 55 | protected $_maxKeysLength = 150; 56 | /** @var array Forbidden for use SEO:url names */ 57 | protected $_stopNames = ['create', 'update', 'delete', 'view', 'index']; 58 | /** @var string SEO route for creating link, example "post/view" */ 59 | protected $_viewRoute = ''; 60 | /** @var string Parameter name, which will be given SEO:url in the creation of link 61 | * Here is an example of a place where this option is used: Url::to(["route", linkTitleParamName=>seo_url]) */ 62 | protected $_linkTitleParamName = 'title'; 63 | /** @var array|callable additional parameters SEO:url to create a link */ 64 | protected $_additionalLinkParams = []; 65 | /** @var array List of languages that should be available to SEO-options */ 66 | protected $_languages = []; 67 | /** @var string The name of a controller class, which operates the current model. 68 | * Must be specified for a list of actions of the controller to seo_url 69 | * did not coincide with the existing actions in the controller */ 70 | protected $_controllerClassName = ''; 71 | /** @var boolean Is it necessary to use only lowercase when generating seo_url */ 72 | protected $_toLowerSeoUrl = true; 73 | /** @var Query Additional criteria when checking the uniqueness of seo_url */ 74 | protected $_uniqueUrlFilter; 75 | /** @var string Regular expression to verify that the request goes to bypass seo_url. 76 | * search string - Yii::app()->request->pathInfo 77 | * If the request is passed to bypass, then it will redirect to the correct of viewUrl */ 78 | protected $_checkSeoUrlRegexp = ''; 79 | /** @var string Encoding */ 80 | protected $_encoding; 81 | /** @var array ['®' => 'trademark', ...] */ 82 | protected $_transliterationList; 83 | /** @var array Replace invalid symbols */ 84 | protected $_replacementRegex = '/[^a-zа-яё\d_-]+/iu'; 85 | /** @var string Replacement char */ 86 | protected $_replacementChar = '-'; 87 | /** @var string Extra char (used for appending string when non-unique) */ 88 | protected $_extraChar = '_'; 89 | /** @var array Array configuration that overrides the above settings */ 90 | public $seoConfig = []; 91 | 92 | const TITLE_KEY = 'title'; 93 | const DESC_KEY = 'desc'; 94 | const KEYS_KEY = 'keys'; 95 | 96 | /** @var array Saved actions of controllers for SEO:url stop list */ 97 | protected static $_controllersActions = []; 98 | 99 | /** 100 | * {@inheritdoc} 101 | */ 102 | public function events() 103 | { 104 | return [ 105 | ActiveRecord::EVENT_BEFORE_INSERT => 'beforeSave', 106 | ActiveRecord::EVENT_BEFORE_UPDATE => 'beforeSave', 107 | ActiveRecord::EVENT_AFTER_FIND => 'afterFind', 108 | ]; 109 | } 110 | 111 | /** 112 | * {@inheritdoc} 113 | */ 114 | public function attach($owner) 115 | { 116 | parent::attach($owner); 117 | 118 | // Apply the configuration options 119 | foreach ($this->seoConfig as $key => $value) { 120 | $var = '_' . $key; 121 | $this->$var = $value; 122 | } 123 | // Set default charset 124 | if (!$this->_encoding) { 125 | $this->_encoding = Yii::$app->charset; 126 | } 127 | 128 | $this->_languages = (array)$this->_languages; 129 | // If there was not passed any language - we use only one system language 130 | if (!count($this->_languages)) { 131 | $this->_languages = [Yii::$app->language]; 132 | } 133 | // if the current user can see and edit SEO-data model 134 | if (is_callable($this->_clientChange)) { 135 | $this->_clientChange = call_user_func($this->_clientChange, $owner); 136 | } 137 | 138 | // If the route to create a seo url link to view model is not specified - generate it 139 | if (empty($this->_viewRoute)) { 140 | $this->_viewRoute = strtolower(basename(get_class($owner))) . '/view'; 141 | } 142 | 143 | // Determine the controller and add it actions to the seo url stop list 144 | if (!empty($this->_urlField) && !empty($this->_controllerClassName)) { 145 | if (isset(static::$_controllersActions[$this->_controllerClassName])) { 146 | // Obtain the previously defined controller actions 147 | $buffer = static::$_controllersActions[$this->_controllerClassName]; 148 | } else { 149 | // Get all actions of controller 150 | $reflection = new \ReflectionClass($this->_controllerClassName); 151 | $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC); 152 | $controller = $reflection->newInstance(Yii::$app->getUniqueId(), null); 153 | // Add all reusable controller actions 154 | $buffer = array_keys($controller->actions()); 155 | // Loop through all the main controller actions 156 | foreach ($methods as $method) { 157 | /* @var $method \ReflectionMethod */ 158 | $name = $method->getName(); 159 | if ($name !== 'actions' && substr($name, 0, 6) == 'action') { 160 | $action = substr($name, 6, strlen($name)); 161 | $action[0] = strtolower($action[0]); 162 | $buffer[] = $action; 163 | } 164 | } 165 | 166 | // Save controller actions for later use 167 | static::$_controllersActions[$this->_controllerClassName] = $buffer; 168 | } 169 | 170 | // Merge controller actions with actions from config behavior 171 | $this->_stopNames = array_unique(array_merge($this->_stopNames, $buffer)); 172 | } 173 | } 174 | 175 | /** 176 | * {@inheritdoc} 177 | */ 178 | public function beforeValidate() 179 | { 180 | $model = $this->owner; 181 | 182 | if (!empty($this->_metaField)) { 183 | // Loop through all the languages available, it is often only one 184 | foreach ($this->_languages as $lang) { 185 | // Loop through the fields and cut the long strings to set allowed length 186 | foreach ($this->getMetaFields() as $meta_param_key => $meta_param_value_generator) { 187 | $this->applyMaxLength($meta_param_key, $lang); 188 | } 189 | } 190 | } 191 | 192 | if (empty($this->_urlField)) { 193 | // If do not need to work with SEO:url, then skip further work 194 | return; 195 | } 196 | 197 | // Add UNIQUE validator for SEO:url field 198 | $validator = Validator::createValidator(UniqueValidator::className(), $model, $this->_urlField, [ 199 | 'filter' => $this->_uniqueUrlFilter, 200 | ]); 201 | 202 | // If SEO: url is not filled by the user, then generate its value 203 | $urlFieldVal = trim((string)$model->{$this->_urlField}); 204 | if ($urlFieldVal === '') { 205 | $urlFieldVal = $this->getProduceFieldValue($this->_urlProduceField); 206 | } 207 | // Transliterated string and remove from it the extra characters 208 | $seoUrl = $this->getSeoName($urlFieldVal, $this->_maxUrlLength, $this->_toLowerSeoUrl); 209 | 210 | // If there is a match with banned names, then add to the url underbar to the end 211 | while (in_array($seoUrl, $this->_stopNames)) { 212 | $seoUrl .= $this->_extraChar; 213 | } 214 | 215 | $model->{$this->_urlField} = $seoUrl; 216 | // Start the first unique validation 217 | $validator->validateAttribute($model, $this->_urlField); 218 | 219 | // Run the validation of up to 50 times, until there is a unique SEO:url name 220 | $i = 0; 221 | while ($model->hasErrors($this->_urlField)) { 222 | // Remove the error message received in the last validation 223 | $model->clearErrors($this->_urlField); 224 | 225 | // If failed 50 times, then something went wrong... 226 | if (++$i > 50) { 227 | // We establish SEO: url to a random hash 228 | $model->{$this->_urlField} = md5(uniqid()); 229 | // Finish "infinite" loop 230 | break; 231 | } 232 | 233 | // Add "_" at the end of SEO:url 234 | $newSeoUrl = $model->{$this->_urlField} . $this->_extraChar; 235 | $model->{$this->_urlField} = $newSeoUrl; 236 | // Run the validator again, because in the previous line, we changed the value of adding a suffix 237 | $validator->validateAttribute($model, $this->_urlField); 238 | } 239 | } 240 | 241 | /** 242 | * {@inheritdoc} 243 | */ 244 | public function beforeSave() 245 | { 246 | $model = $this->owner; 247 | $this->beforeValidate(); 248 | 249 | if (empty($this->_metaField)) { 250 | // Unless specified meta-field, then we will not save 251 | return; 252 | } 253 | 254 | // Check all the SEO field and populate them with data, if specified by the user - leave as is, if there is no - generate 255 | $this->fillMeta(); 256 | 257 | $meta = $model->{$this->_metaField}; 258 | 259 | // Save all data in a serialized form 260 | $model->{$this->_metaField} = serialize($meta); 261 | } 262 | 263 | /** 264 | * {@inheritdoc} 265 | */ 266 | public function afterFind() 267 | { 268 | $model = $this->owner; 269 | 270 | if (!empty($this->_metaField)) { 271 | // Unpack meta-params 272 | $meta = @unserialize($model->{$this->_metaField}); 273 | if (!is_array($meta)) { 274 | $meta = []; 275 | } 276 | 277 | $model->{$this->_metaField} = $meta; 278 | } 279 | } 280 | 281 | /** 282 | * Returns the metadata for this model 283 | * 284 | * @param string|null $lang language, which requires meta-data 285 | * 286 | * @return array 287 | */ 288 | public function getSeoData($lang = null) 289 | { 290 | if (empty($lang)) { 291 | $lang = Yii::$app->language; 292 | } 293 | 294 | $buffer = []; 295 | 296 | if (!empty($this->_metaField)) { 297 | // Check that all meta-fields were filled with the values 298 | $this->fillMeta(); 299 | } 300 | 301 | // If meta stored in a model, then refund the value of the model fields, otherwise will generate data on the fly 302 | $getValMethodName = !empty($this->_metaField) ? 'getMetaFieldVal' : 'getProduceFieldValue'; 303 | 304 | foreach ($this->getMetaFields() as $meta_params_key => $meta_param_value_generator) { 305 | // Choosing what parameters are passed to the function get the value: the name of the field or function-generator 306 | $getValMethodParam = !empty($this->_metaField) ? $meta_params_key : $meta_param_value_generator; 307 | // Directly receiving the value of any meta-field of the model or generate it 308 | $buffer[$meta_params_key] = $this->$getValMethodName($getValMethodParam, $lang); 309 | } 310 | 311 | 312 | return $buffer; 313 | } 314 | 315 | /** 316 | * Return instance of current behavior 317 | * 318 | * @return SeoModelBehavior $this 319 | */ 320 | public function getSeoBehavior() 321 | { 322 | return $this; 323 | } 324 | 325 | /** 326 | * Returns the URL to the page viewing for current model-owner 327 | * 328 | * @param string $title SEO:title for the url, use only if the reference is not generated from the model, and externally 329 | * @param string $anchor #Anchor, which is added to the url ($title can be set to NULL) 330 | * @param boolean $abs Need a absolute link ($title and $anchor can be set to NULL) 331 | * 332 | * @return string 333 | */ 334 | public function getViewUrl($title = null, $anchor = null, $abs = false) 335 | { 336 | // If additional link parameters should be generated - do generate 337 | if (is_callable($this->_additionalLinkParams)) { 338 | $this->_additionalLinkParams = call_user_func($this->_additionalLinkParams, $this->owner); 339 | } 340 | 341 | // If the model does not have SEO: url, then the value of this field will be used by the Model ID 342 | if (empty($this->_urlField) && empty($title)) { 343 | $title = $this->owner->getPrimaryKey(); 344 | } 345 | 346 | // Add the parameter that is responsible for displaying SEO:url 347 | $params = [$this->_linkTitleParamName => !empty($title) ? $title : $this->owner->{$this->_urlField}]; 348 | 349 | // Adding anchor 350 | if (!empty($anchor)) { 351 | $params['#'] = $anchor; 352 | } 353 | 354 | return Url::to(array_merge([$this->_viewRoute], array_merge($params, $this->_additionalLinkParams)), $abs); 355 | } 356 | 357 | /** 358 | * Returns the absolute URL to the page view model-owner 359 | * 360 | * @param string $title SEO:title for the url, use only if the reference is not generated from the model, and externally 361 | * @param string $anchor Якорь, который добвится к url, а $title можно указать как NULL#Anchor, which is added to the url ($title can be set to NULL) 362 | * 363 | * @return string 364 | */ 365 | public function getAbsoluteViewUrl($title = null, $anchor = null) 366 | { 367 | return $this->getViewUrl($title, $anchor, true); 368 | } 369 | 370 | /** 371 | * Render the SEO field for a form 372 | * 373 | * @param ActiveForm $form 374 | */ 375 | public function renderFormSeoFields($form = null) 376 | { 377 | // If the parameters can not be edited manually - it means nothing to display them in the form of 378 | if (!$this->_clientChange) { 379 | return; 380 | } 381 | 382 | $model = $this->owner; 383 | 384 | echo '
'; 385 | 386 | if ($form instanceof ActiveForm) { 387 | echo $form->field($model, $this->_urlField)->textInput(); 388 | } else { 389 | echo '
'; 390 | echo Html::activeLabel($model, $this->_urlField); 391 | echo Html::activeTextInput($model, $this->_urlField); 392 | echo Html::error($model, $this->_urlField); 393 | echo "
\n\n"; 394 | } 395 | 396 | foreach ($this->_languages as $lang) { 397 | foreach ($this->getMetaFields() as $meta_field_key => $meta_field_generator) { 398 | $attr = $this->_metaField . "[{$meta_field_key}_{$lang}]"; 399 | $label = 'SEO: ' . $meta_field_key; 400 | if (count($this->_languages) > 1) { 401 | $label .= ' ' . strtoupper($lang); 402 | } 403 | if ($form instanceof ActiveForm) { 404 | $input = $meta_field_key == self::DESC_KEY ? 'textarea' : 'textInput'; 405 | echo $form->field($model, $attr)->label($label)->$input(); 406 | } else { 407 | $input = $meta_field_key == self::DESC_KEY ? 'activeTextarea' : 'activeTextInput'; 408 | echo '
'; 409 | echo Html::activeLabel($model, $attr, ['label' => $label]); 410 | echo Html::$input($model, $attr); 411 | echo Html::error($model, $attr); 412 | echo "
\n"; 413 | } 414 | } 415 | } 416 | } 417 | 418 | /** 419 | * Verifies that only correct seo_url is used for current url 420 | * @return boolean true if all is well, otherwise occurs 301 redirect to the correct URL 421 | */ 422 | public function checkSeoUrl() 423 | { 424 | if (!empty($this->check_seo_url_regexp) && preg_match($this->_checkSeoUrlRegexp, Yii::$app->request->pathInfo) 425 | ) { 426 | Yii::$app->response->redirect($this->getViewUrl(), 301); 427 | } 428 | 429 | return true; 430 | } 431 | 432 | /** 433 | * Returns usable SEO name 434 | * 435 | * @param string $title 436 | * @param int $maxLength 437 | * @param bool $to_lower 438 | * 439 | * @return string 440 | */ 441 | protected function getSeoName($title, $maxLength = 255, $to_lower = true) 442 | { 443 | $trans = [ 444 | 'а' => 'a', 'б' => 'b', 'в' => 'v', 'г' => 'g', 'д' => 'd', 'е' => 'e', 'ё' => 'yo', 'ж' => 'j', 'з' => 'z', 'и' => 'i', 'й' => 'i', 'к' => 'k', 'л' => 'l', 'м' => 'm', 'н' => 'n', 'о' => 'o', 'п' => 'p', 'р' => 'r', 'с' => 's', 'т' => 't', 'у' => 'y', 'ф' => 'f', 'х' => 'h', 'ц' => 'c', 'ч' => 'ch', 'ш' => 'sh', 'щ' => 'sh', 'ы' => 'i', 'э' => 'e', 'ю' => 'u', 'я' => 'ya', 445 | 'А' => 'A', 'Б' => 'B', 'В' => 'V', 'Г' => 'G', 'Д' => 'D', 'Е' => 'E', 'Ё' => 'Yo', 'Ж' => 'J', 'З' => 'Z', 'И' => 'I', 'Й' => 'I', 'К' => 'K', 'Л' => 'L', 'М' => 'M', 'Н' => 'N', 'О' => 'O', 'П' => 'P', 'Р' => 'R', 'С' => 'S', 'Т' => 'T', 'У' => 'Y', 'Ф' => 'F', 'Х' => 'H', 'Ц' => 'C', 'Ч' => 'Ch', 'Ш' => 'Sh', 'Щ' => 'Sh', 'Ы' => 'I', 'Э' => 'E', 'Ю' => 'U', 'Я' => 'Ya', 446 | 'ь' => '', 'Ь' => '', 'ъ' => '', 'Ъ' => '', 447 | ]; 448 | if ($this->_transliterationList) { 449 | // Use custom trans-list 450 | $trans = $this->_transliterationList; 451 | } 452 | // Replace the unusable characters on the dashes 453 | $title = preg_replace($this->_replacementRegex, $this->_replacementChar, $title); 454 | // Remove dashes from the beginning and end of the line 455 | $title = trim($title, $this->_replacementChar); 456 | $title = strtr($title, $trans); 457 | if ($to_lower) { 458 | $title = mb_strtolower($title, $this->_encoding); 459 | } 460 | if (mb_strlen($title, $this->_encoding) > $maxLength) { 461 | $title = mb_substr($title, 0, $maxLength, $this->_encoding); 462 | } 463 | 464 | // Return usable string 465 | return $title; 466 | } 467 | 468 | /** 469 | * Verifies the maximum length of meta-strings, and if it exceeds the limit - cuts to the maximum value 470 | * 471 | * @param string $key 472 | * @param string $lang 473 | */ 474 | protected function applyMaxLength($key, $lang) 475 | { 476 | $value = trim($this->getMetaFieldVal($key, $lang)); 477 | if ($key === self::TITLE_KEY) { 478 | $max = $this->_maxTitleLength; 479 | } elseif ($key === self::DESC_KEY) { 480 | $max = $this->_maxDescLength; 481 | } else { 482 | $max = $this->_maxKeysLength; 483 | } 484 | 485 | if (mb_strlen($value, $this->_encoding) > $max) { 486 | $value = mb_substr($value, 0, $max, $this->_encoding); 487 | } 488 | 489 | $this->setMetaFieldVal($key, $lang, $value); 490 | } 491 | 492 | /** 493 | * Checks completion of all SEO:meta fields. In their absence, they will be generated. 494 | */ 495 | protected function fillMeta() 496 | { 497 | // Loop through all the languages available, it is often only one 498 | foreach ($this->_languages as $lang) { 499 | // Loop through the meta-fields and fill them in the absence of complete data 500 | foreach ($this->getMetaFields() as $meta_params_key => $meta_param_value_generator) { 501 | $meta_params_val = $this->getMetaFieldVal($meta_params_key, $lang); 502 | if (empty($meta_params_val) && $meta_param_value_generator !== null) { 503 | // Get value from the generator 504 | $meta_params_val = $this->getProduceFieldValue($meta_param_value_generator, $lang); 505 | $this->setMetaFieldVal($meta_params_key, $lang, $this->normalizeStr($meta_params_val)); 506 | } 507 | // We verify that the length of the string in the normal 508 | $this->applyMaxLength($meta_params_key, $lang); 509 | } 510 | } 511 | } 512 | 513 | /** 514 | * Returns an array of meta-fields. As the value goes callback function 515 | * 516 | * @return callable[] 517 | */ 518 | protected function getMetaFields() 519 | { 520 | return [ 521 | static::TITLE_KEY => $this->_titleProduceFunc, 522 | static::DESC_KEY => $this->_descriptionProduceFunc, 523 | static::KEYS_KEY => $this->_keysProduceFunc, 524 | ]; 525 | } 526 | 527 | /** 528 | * Returns the value of the $key SEO:meta for the specified $lang language 529 | * 530 | * @param string $key key TITLE_KEY, DESC_KEY or KEYS_KEY 531 | * @param string $lang language 532 | * 533 | * @return string|null 534 | */ 535 | protected function getMetaFieldVal($key, $lang) 536 | { 537 | $param = $key . '_' . $lang; 538 | $meta = $this->owner->{$this->_metaField}; 539 | 540 | return is_array($meta) && isset($meta[$param]) ? $meta[$param] : null; 541 | } 542 | 543 | /** 544 | * Sets the value of $key in SEO:meta on the specified $lang language 545 | * 546 | * @param string $key key TITLE_KEY, DESC_KEY or KEYS_KEY 547 | * @param string $lang language 548 | * @param string $value field value 549 | */ 550 | protected function setMetaFieldVal($key, $lang, $value) 551 | { 552 | $model = $this->owner; 553 | $param = $key . '_' . $lang; 554 | $meta = $model->{$this->_metaField}; 555 | if (!is_array($meta)) { 556 | $meta = []; 557 | } 558 | 559 | $meta[$param] = (string)$value; 560 | 561 | $model->{$this->_metaField} = $meta; 562 | } 563 | 564 | /** 565 | * Normalize string, prepares it for recording in the database 566 | * 567 | * @param string $str 568 | * 569 | * @return string 570 | */ 571 | protected function normalizeStr($str) 572 | { 573 | // Replace all spaces, line breaks and tabs with a single space char 574 | $str = preg_replace('/[\s]+/iu', ' ', $str); 575 | $str = trim(strip_tags($str)); 576 | 577 | return $str; 578 | } 579 | 580 | /** 581 | * Returns the generated value for the meta-fields 582 | * 583 | * @param callable|string $produceFunc 584 | * @param string $lang 585 | * 586 | * @return string 587 | */ 588 | protected function getProduceFieldValue($produceFunc, $lang = null) 589 | { 590 | // Save current site language 591 | $originalLanguage = Yii::$app->language; 592 | // Change site language to $lang 593 | if (!empty($lang)) { 594 | Yii::$app->language = $lang; 595 | } 596 | 597 | $model = $this->owner; 598 | if (is_callable($produceFunc)) { 599 | $value = (string)call_user_func($produceFunc, $model, $lang); 600 | } else { 601 | $value = (string)$model->{$produceFunc}; 602 | } 603 | 604 | // Restore original site language 605 | Yii::$app->language = $originalLanguage; 606 | 607 | return $value; 608 | } 609 | } 610 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------