├── .travis.yml ├── API.php ├── Component ├── Generator.php ├── NoCache.php ├── ShortcodeCache.php ├── ShortcodeValidator.php ├── UrlValidator.php └── Validator.php ├── Controller.php ├── Exception ├── InvalidShortcodeException.php ├── ShortcodeDuplicateException.php └── UnableToRedirectException.php ├── LICENSE ├── Model ├── Model.php └── ModelInterface.php ├── README.md ├── Reports ├── Base.php ├── GetExternalShortcodeUsageReport.php ├── GetShortcodeUsageReport.php ├── GetShortenedExternalPagesReport.php └── GetShortenedPagesReport.php ├── ShortcodeTracker.php ├── SystemSettings.php ├── Tracker └── RedirectTracker.php ├── Widgets └── GetShortcodegenerator.php ├── changelog.md ├── composer.json ├── docs ├── apache_config.txt └── nginx_config.txt ├── images ├── shorten_icon.png └── shorten_icon_hover.png ├── javascripts ├── rowaction.js └── shortcodeGenerating.js ├── lang └── en.json ├── plugin.json ├── screenshots ├── .gitkeep ├── screenshot1.png ├── screenshot2.png ├── screenshot3.png └── screenshot4.png ├── stylesheets └── styles.less ├── templates ├── index.twig └── singleShortcode.twig └── tests ├── Integration └── ShortcodeApiTest.php └── Unit ├── ShortcodeGeneratorTest.php ├── ShortcodeUrlValidatorTest.php └── ShortcodeValidatorTest.php /.travis.yml: -------------------------------------------------------------------------------- 1 | # do not edit this file manually, instead run the generate:travis-yml console command 2 | 3 | language: php 4 | 5 | php: 6 | - 5.6 7 | - 7 8 | # - hhvm 9 | 10 | services: 11 | - redis-server 12 | 13 | addons: 14 | apt: 15 | sources: 16 | - deadsnakes 17 | 18 | packages: 19 | - python2.6 20 | - python2.6-dev 21 | - nginx 22 | - realpath 23 | - lftp 24 | 25 | # Separate different test suites 26 | env: 27 | global: 28 | - PLUGIN_NAME=ShortcodeTracker 29 | - PIWIK_ROOT_DIR=$TRAVIS_BUILD_DIR/piwik 30 | # this variable controls the version of Piwik your tests will run against. 31 | # by default it will run against the maximum support version read from plugin.json 32 | # (PIWIK_TEST_TARGET=maximum_supported_piwik). 33 | # You can also specify a specific Piwik version 34 | # (PIWIK_TEST_TARGET=2.16.0-b1). 35 | - PIWIK_TEST_TARGET=maximum_supported_piwik 36 | matrix: 37 | - TEST_SUITE=PluginTests MYSQL_ADAPTER=PDO_MYSQL TEST_AGAINST_PIWIK_BRANCH=$PIWIK_TEST_TARGET 38 | - TEST_SUITE=PluginTests MYSQL_ADAPTER=PDO_MYSQL TEST_AGAINST_CORE=minimum_required_piwik 39 | 40 | matrix: 41 | exclude: 42 | # execute latest stable tests only w/ PHP 5.5 43 | - php: 5.3 44 | env: TEST_SUITE=PluginTests MYSQL_ADAPTER=PDO_MYSQL TEST_AGAINST_CORE=minimum_required_piwik 45 | 46 | sudo: required 47 | 48 | script: $PIWIK_ROOT_DIR/tests/travis/travis.sh 49 | 50 | before_install: 51 | # do not use the Zend allocator on PHP 5.3 since it will randomly segfault after program execution 52 | - '[[ "$TRAVIS_PHP_VERSION" == 5.3* ]] && export USE_ZEND_ALLOC=0 || true' 53 | 54 | install: 55 | # move all contents of current repo (which contains the plugin) to a new directory 56 | - mkdir $PLUGIN_NAME 57 | - cp -R !($PLUGIN_NAME) $PLUGIN_NAME 58 | - cp -R .git/ $PLUGIN_NAME/ 59 | - cp .travis.yml $PLUGIN_NAME 60 | # checkout piwik in the current directory 61 | - git clone -q https://github.com/piwik/piwik.git piwik 62 | - cd piwik 63 | - git fetch -q --all 64 | - git submodule update 65 | 66 | # make sure travis-scripts repo is latest for initial travis setup 67 | - '[ -d ./tests/travis/.git ] || sh -c "rm -rf ./tests/travis && git clone https://github.com/piwik/travis-scripts.git ./tests/travis"' 68 | - cd ./tests/travis ; git checkout master ; cd ../.. 69 | 70 | - export GENERATE_TRAVIS_YML_COMMAND="php ./tests/travis/generator/main.php generate:travis-yml --plugin=\"ShortcodeTracker\" --verbose" 71 | - '[[ "$TRAVIS_JOB_NUMBER" != *.1 || "$TRAVIS_PULL_REQUEST" != "false" ]] || ./tests/travis/autoupdate_travis_yml.sh' 72 | 73 | - ./tests/travis/checkout_test_against_branch.sh 74 | 75 | - '[ "$PLUGIN_NAME" == "" ] || [ ! -f ./tests/travis/check_plugin_compatible_with_piwik.php ] || php ./tests/travis/check_plugin_compatible_with_piwik.php "$PLUGIN_NAME"' 76 | 77 | - ./tests/travis/configure_git.sh 78 | 79 | # disable tls for php 5.3 as openssl isn't available 80 | - '[[ "$TRAVIS_PHP_VERSION" == 5.3* ]] && composer config -g -- disable-tls true || true' 81 | 82 | # travis now complains about this failing 9 times out of 10, so removing it 83 | #- travis_retry composer self-update 84 | - '[ "$SKIP_COMPOSER_INSTALL" == "1" ] || travis_retry composer install' 85 | 86 | 87 | # move plugin contents to folder in the plugins subdirectory 88 | - rm -rf plugins/$PLUGIN_NAME 89 | - mv ../$PLUGIN_NAME plugins 90 | 91 | # clone dependent repos 92 | - ./tests/travis/checkout_dependent_plugins.sh 93 | 94 | before_script: 95 | - if [[ "$TRAVIS_PHP_VERSION" != 7* ]]; then phpenv config-rm xdebug.ini; fi 96 | 97 | # add always_populate_raw_post_data=-1 to php.ini 98 | - echo "always_populate_raw_post_data=-1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini 99 | 100 | # disable opcache to avoid random failures on travis 101 | - echo "opcache.enable=0" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini 102 | 103 | # make tmpfs and run MySQL on it for reasonnable performance 104 | - sudo mkdir /mnt/ramdisk 105 | - sudo mount -t tmpfs -o size=1024m tmpfs /mnt/ramdisk 106 | - sudo stop mysql 107 | - sudo mv /var/lib/mysql /mnt/ramdisk 108 | - sudo ln -s /mnt/ramdisk/mysql /var/lib/mysql 109 | - sudo start mysql 110 | 111 | # print out mysql information 112 | - mysql --version 113 | - mysql -e "SELECT VERSION();" 114 | 115 | # configure mysql 116 | - mysql -e "SET GLOBAL sql_mode = 'NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES'" # Travis default 117 | # try to avoid 'mysql has gone away' errors 118 | - mysql -e "SET GLOBAL wait_timeout = 36000;" 119 | - mysql -e "SET GLOBAL max_allowed_packet = 134209536;" 120 | - mysql -e "SHOW VARIABLES LIKE 'max_allowed_packet';" 121 | - mysql -e "SHOW VARIABLES LIKE 'wait_timeout';" 122 | 123 | - mysql -e "SELECT @@sql_mode;" 124 | # - mysql -e "SHOW GLOBAL VARIABLES;" 125 | 126 | # print out more debugging info 127 | - uname -a 128 | - date 129 | - php -r "var_dump(gd_info());" 130 | - mysql -e 'create database piwik_tests;' 131 | 132 | - ./tests/travis/prepare.sh 133 | - ./tests/travis/setup_webserver.sh 134 | 135 | - cd tests/PHPUnit 136 | 137 | after_script: 138 | # change directory back to root travis dir 139 | - cd $PIWIK_ROOT_DIR 140 | 141 | # output contents of files w/ debugging info to screen 142 | - cat $PIWIK_ROOT_DIR/tests/travis/error.log 143 | - cat $PIWIK_ROOT_DIR/tmp/php-fpm.log 144 | - cat $PIWIK_ROOT_DIR/tmp/logs/piwik.log 145 | - cat $PIWIK_ROOT_DIR/config/config.ini.php 146 | 147 | # upload test artifacts (for debugging travis failures) 148 | - ./tests/travis/upload_artifacts.sh 149 | 150 | after_success: 151 | - cd $PIWIK_ROOT_DIR 152 | -------------------------------------------------------------------------------- /API.php: -------------------------------------------------------------------------------- 1 | model === null) 75 | { 76 | $this->model = new Model(); 77 | } 78 | 79 | return $this->model; 80 | } 81 | 82 | /** 83 | * @hideForAll 84 | * @codeCoverageIgnore 85 | * 86 | * @param Model $model 87 | */ 88 | public function setModel($model) 89 | { 90 | $this->checkUserNotAnonymous(); 91 | $this->model = $model; 92 | } 93 | 94 | /** 95 | * @hideForAll 96 | * @codeCoverageIgnore 97 | * @return UrlValidator 98 | */ 99 | public function getUrlValidator() 100 | { 101 | if ($this->urlValidator === null) 102 | { 103 | $this->urlValidator = new UrlValidator(); 104 | } 105 | 106 | return $this->urlValidator; 107 | } 108 | 109 | /** 110 | * @hideForAll 111 | * @codeCoverageIgnore 112 | * 113 | * @param UrlValidator $urlValidator 114 | */ 115 | public function setUrlValidator($urlValidator) 116 | { 117 | $this->checkUserNotAnonymous(); 118 | $this->urlValidator = $urlValidator; 119 | } 120 | 121 | /** 122 | * @return ShortcodeValidator 123 | */ 124 | public function getShortCodeValidator() 125 | { 126 | if ($this->shortCodeValidator === null) 127 | { 128 | $this->shortCodeValidator = new ShortcodeValidator(); 129 | } 130 | 131 | return $this->shortCodeValidator; 132 | } 133 | 134 | /** 135 | * @param ShortcodeValidator $shortCodeValidator 136 | */ 137 | public function setShortCodeValidator($shortCodeValidator) 138 | { 139 | $this->checkUserNotAnonymous(); 140 | $this->shortCodeValidator = $shortCodeValidator; 141 | } 142 | 143 | 144 | /** 145 | * @hideForAll 146 | * @codeCoverageIgnore 147 | * @return ShortcodeCache 148 | */ 149 | public function getCache() 150 | { 151 | if ($this->cache === null) 152 | { 153 | $this->cache = new NoCache($this->getModel()); 154 | } 155 | 156 | return $this->cache; 157 | } 158 | 159 | /** 160 | * @hideForAll 161 | * @codeCoverageIgnore 162 | * 163 | * @param Cache @cache 164 | */ 165 | public function setCache(ShortcodeCache $cache) 166 | { 167 | $this->checkUserNotAnonymous(); 168 | $this->cache = $cache; 169 | } 170 | 171 | /** 172 | * @hideForAll 173 | * @codeCoverageIgnore 174 | * @return Generator 175 | */ 176 | public function getGenerator() 177 | { 178 | $this->checkUserNotAnonymous(); 179 | if ($this->generator === null) 180 | { 181 | $this->generator = new Generator( 182 | $this->getModel(), 183 | $this->getUrlValidator(), 184 | $this->getShortcodeValidator(), 185 | $this->getSitesManagerAPI()); 186 | } 187 | 188 | return $this->generator; 189 | } 190 | 191 | /** 192 | * @hideForAll 193 | * @codeCoverageIgnore 194 | * 195 | * @param Generator $generator 196 | */ 197 | public function setGenerator($generator) 198 | { 199 | $this->checkUserNotAnonymous(); 200 | $this->generator = $generator; 201 | } 202 | 203 | /** 204 | * @hideForAll 205 | * @codeCoverageIgnore 206 | * @return SystemSettings 207 | */ 208 | public function getPluginSettings() 209 | { 210 | if ($this->pluginSettings === null) 211 | { 212 | $this->pluginSettings = new SystemSettings(); 213 | } 214 | 215 | return $this->pluginSettings; 216 | } 217 | 218 | /** 219 | * @hideForAll 220 | * @codeCoverageIgnore 221 | * 222 | * @param SystemSettings $pluginSettings 223 | */ 224 | public function setPluginSettings($pluginSettings) 225 | { 226 | $this->checkUserNotAnonymous(); 227 | $this->pluginSettings = $pluginSettings; 228 | } 229 | 230 | 231 | /** 232 | * @hideForAll 233 | * @codeCoverageIgnore 234 | * @return SitesManagerAPI 235 | */ 236 | public function getSitesManagerAPI() 237 | { 238 | $this->checkUserNotAnonymous(); 239 | 240 | if ($this->sitesManagerAPI === null) 241 | { 242 | $this->sitesManagerAPI = SitesManagerAPI::getInstance(); 243 | } 244 | 245 | return $this->sitesManagerAPI; 246 | } 247 | 248 | /** 249 | * @hideForAll 250 | * @codeCoverageIgnore 251 | * 252 | * @param SitesManagerAPI $sitesManagerAPI 253 | */ 254 | public function setSitesManagerAPI($sitesManagerAPI) 255 | { 256 | $this->checkUserNotAnonymous(); 257 | $this->sitesManagerAPI = $sitesManagerAPI; 258 | } 259 | 260 | /** 261 | * @return string 262 | */ 263 | public function checkMinimalRequiredAccess() 264 | { 265 | Piwik::checkUserIsNotAnonymous(); 266 | } 267 | 268 | /** 269 | * @param $url 270 | * @param $useExistingCodeIfAvailable 271 | * 272 | * @return bool|string 273 | */ 274 | public function generateShortenedUrl($url, $useExistingCodeIfAvailable = false) 275 | { 276 | $this->checkMinimalRequiredAccess(); 277 | 278 | $settings = $this->getPluginSettings(); 279 | $baseUrl = $settings->getSetting(ShortcodeTracker::SHORTENER_URL_SETTING); 280 | $response = $this->generateShortcodeForUrl($url, $useExistingCodeIfAvailable); 281 | 282 | $shortcodeValidator = new ShortcodeValidator(); 283 | if ($shortcodeValidator->validate($response)) 284 | { 285 | return $baseUrl . $response; 286 | } 287 | 288 | return $response; 289 | } 290 | 291 | /** 292 | * @param $url 293 | * @param bool|false $useExistingCodeIfAvailable 294 | * 295 | * @return bool|string 296 | */ 297 | public function generateShortcodeForUrl($url, $useExistingCodeIfAvailable = false) 298 | { 299 | $sanitizedUrl = html_entity_decode($url); 300 | $generator = $this->getGenerator(); 301 | $shortcodeIdsite = $generator->getIdSiteForUrl($sanitizedUrl); 302 | $this->checkUserHasWriteAccess($shortcodeIdsite); 303 | 304 | $shortcode = false; 305 | 306 | if ($useExistingCodeIfAvailable === "1") 307 | { 308 | $shortcode = $this->getModel()->selectShortcodeByUrl($sanitizedUrl); 309 | } 310 | 311 | if ($shortcode === false) 312 | { 313 | $shortcode = $generator->generateShortcode($sanitizedUrl); 314 | if ($shortcode === false) 315 | { 316 | return Piwik::translate('ShortcodeTracker_unable_to_generate_shortcode'); 317 | } 318 | 319 | $this->getModel()->insertShortcode($shortcode, $sanitizedUrl, $shortcodeIdsite); 320 | } 321 | 322 | return $shortcode; 323 | 324 | } 325 | 326 | /** 327 | * @param $code 328 | * 329 | * @return string 330 | */ 331 | public function getUrlFromShortcode($code) 332 | { 333 | $this->checkUserNotAnonymous(); 334 | 335 | $shortcode = $this->getModel()->selectShortcodeByCode($code); 336 | 337 | return $shortcode ? $shortcode['url'] : Piwik::translate('ShortcodeTracker_invalid_shortcode'); 338 | } 339 | 340 | /** 341 | * @param $code 342 | * 343 | * @throws UnableToRedirectException 344 | */ 345 | public function performRedirectForShortcode($code) 346 | { 347 | $shortCode = $this->getCache()->getShortcode($code); 348 | 349 | Piwik::postEvent(ShortcodeTracker::TRACK_REDIRECT_VISIT_EVENT, array($shortCode)); 350 | 351 | if ($shortCode === null) 352 | { 353 | throw new UnableToRedirectException(Piwik::translate('ShortcodeTracker_unable_to_perform_redirect')); 354 | } 355 | 356 | header('Location: ' . $shortCode['url']); 357 | } 358 | 359 | 360 | public function getShortcodeUsageReport($idSite, $period, $date, $segment = false, $columns = false) 361 | { 362 | $this->checkUserNotAnonymous(); 363 | $eventsApi = EventsAPI::getInstance(); 364 | 365 | $eventReport = $eventsApi 366 | ->getCategory($idSite, $period, $date, $segment); 367 | 368 | if ($eventReport->getRowsCount() === 0 || 369 | $eventReport->getRowFromLabel(ShortcodeTracker::REDIRECT_EVENT_CATEGORY) === false 370 | ) 371 | { 372 | return new DataTable(); 373 | } 374 | 375 | $shortcodeReportIdSubtable = $eventReport 376 | ->getRowFromLabel(ShortcodeTracker::REDIRECT_EVENT_CATEGORY) 377 | ->getIdSubDataTable(); 378 | 379 | if ($shortcodeReportIdSubtable) 380 | { 381 | $report = $eventsApi->getNameFromCategoryId($idSite, $period, $date, $shortcodeReportIdSubtable); 382 | $enrichedReport = $this->enrichReportWithShortcodeUrls($report); 383 | 384 | return $enrichedReport; 385 | } 386 | 387 | return false; 388 | } 389 | 390 | public function getExternalShortcodeUsageReport($idSite, $period, $date, $segment = false, $columns = false) 391 | { 392 | $this->checkUserNotAnonymous(); 393 | /** @var SystemSettings $settings */ 394 | $settings = $this->getPluginSettings(); 395 | $idSite = $settings->getSetting(ShortcodeTracker::SHORTENER_EXTERNAL_SHORTCODES_IDSITE)->getValue(); 396 | $eventsApi = EventsAPI::getInstance(); 397 | 398 | $eventReport = $eventsApi 399 | ->getCategory($idSite, $period, $date, $segment); 400 | 401 | if ($eventReport->getRowsCount() === 0) 402 | { 403 | return new DataTable(); 404 | } 405 | 406 | $shortcodeReportIdSubtable = $eventReport 407 | ->getRowFromLabel(ShortcodeTracker::REDIRECT_EVENT_CATEGORY) 408 | ->getIdSubDataTable(); 409 | 410 | if ($shortcodeReportIdSubtable) 411 | { 412 | $report = $eventsApi->getNameFromCategoryId($idSite, $period, $date, $shortcodeReportIdSubtable); 413 | $enrichedReport = $this->enrichReportWithShortcodeUrls($report); 414 | 415 | return $enrichedReport; 416 | } 417 | 418 | return false; 419 | } 420 | 421 | public function getShortenedPagesReport($idSite, $period, $date, $segment = false, $columns = false) 422 | { 423 | $report = $this->getShortcodeUsageReport($idSite, $period, $date, $segment, $columns); 424 | 425 | if ($report !== false) 426 | { 427 | $report = $this->summarizeByShortenedUrl($report); 428 | } 429 | 430 | return $report; 431 | } 432 | 433 | public function getShortenedExternalPagesReport($idSite, $period, $date, $segment = false, $columns = false) 434 | { 435 | $report = $this->getExternalShortcodeUsageReport($idSite, $period, $date, $segment, $columns); 436 | if ($report !== false) 437 | { 438 | $report = $this->summarizeByShortenedUrl($report); 439 | } 440 | 441 | return $report; 442 | 443 | } 444 | 445 | protected function checkUserNotAnonymous() 446 | { 447 | Piwik::checkUserIsNotAnonymous(); 448 | } 449 | 450 | protected function checkUserHasWriteAccess($idSite = null) 451 | { 452 | if ($idSite != false) 453 | { 454 | Piwik::checkUserHasWriteAccess($idSite); 455 | return; 456 | } 457 | $settings = $this->getPluginSettings(); 458 | $externalShortcodesIdSite = $settings->getSetting(ShortcodeTracker::SHORTENER_EXTERNAL_SHORTCODES_IDSITE)->getValue(); 459 | if ($externalShortcodesIdSite !== null) 460 | { 461 | Piwik::checkUserHasWriteAccess($externalShortcodesIdSite); 462 | return; 463 | } 464 | Piwik::checkUserHasSuperUserAccess(); 465 | } 466 | 467 | /** 468 | * @param DataTable $report 469 | * 470 | * @return DataTable 471 | */ 472 | protected function enrichReportWithShortcodeUrls(DataTable $report) 473 | { 474 | $model = $this->getModel(); 475 | $filter = new DataTable\Filter\ColumnCallbackAddColumn($report, 'label', 'shortcode_url', (function ($code) use ($model) { 476 | $shortcode = $model->selectShortcodeByCode($code); 477 | 478 | return $shortcode['url']; 479 | })); 480 | 481 | $filter->filter($report); 482 | 483 | foreach ($report->getRows() as $row) 484 | { 485 | $row->setMetadata('url', $row['shortcode_url']); 486 | } 487 | 488 | return $report; 489 | } 490 | 491 | protected function summarizeByShortenedUrl(DataTable $report) 492 | { 493 | $report->renameColumn('shortcode_url', 'label'); 494 | $filter = new DataTable\Filter\GroupBy($report, 'label'); 495 | $filter->filter($report); 496 | 497 | return $report; 498 | } 499 | 500 | 501 | /** 502 | * Another example method that returns a data table. 503 | * @param int $idSite 504 | * @param string $period 505 | * @param string $date 506 | * @param bool|string $segment 507 | * @return DataTable 508 | */ 509 | public function getShortcodes($idSite, $period, $date, $segment = false) 510 | { 511 | $table = new DataTable(); 512 | 513 | $table->addRowFromArray(array(Row::COLUMNS => array('nb_visits' => 5))); 514 | 515 | return $table; 516 | } 517 | 518 | } 519 | -------------------------------------------------------------------------------- /Component/Generator.php: -------------------------------------------------------------------------------- 1 | model = $model; 66 | $this->urlValidator = $urlValidator; 67 | $this->shortcodeValidator = $shortcodeValidator; 68 | $this->sitesManager = $sitesManagerAPI; 69 | } 70 | 71 | /** 72 | * @param $url 73 | * 74 | * @return bool 75 | */ 76 | public function generateShortcode($url) 77 | { 78 | if ($this->urlValidator->validate($url)) { 79 | $shortcode = $this->iterateToGetShortcode($url); 80 | 81 | return $shortcode; 82 | } 83 | 84 | return false; 85 | } 86 | 87 | /** 88 | * @param $url 89 | * @codeCoverageIgnore 90 | * @return bool|void 91 | */ 92 | public function isValidUrl($url) 93 | { 94 | return $this->urlValidator->validate($url); 95 | } 96 | 97 | /** 98 | * @return string 99 | */ 100 | private function generate($url) 101 | { 102 | $code = substr(md5($url . uniqid()), 0, Generator::$SHORTCODE_LENGTH); 103 | 104 | return $code; 105 | } 106 | 107 | private function iterateToGetShortcode($url) 108 | { 109 | $attempts = 1; 110 | while ($attempts < self::$GENERATIONS_MAX_ATTEMPT_NUMBER) { 111 | $shortcode = $this->generate($url); 112 | if ($this->checkIfUnique($shortcode) 113 | && $this->shortcodeValidator->validate($shortcode)) { 114 | return $shortcode; 115 | } 116 | $attempts++; 117 | } 118 | 119 | return false; 120 | } 121 | 122 | /** 123 | * @param string $code 124 | * 125 | * @return bool 126 | */ 127 | public function checkIfUnique($code) 128 | { 129 | return ($this->model->selectShortcodeByCode($code) === false); 130 | } 131 | 132 | /** 133 | * @param $url 134 | * 135 | * @return bool 136 | */ 137 | public function getIdSiteForUrl($url) 138 | { 139 | $allSites = Access::doAsSuperUser(function(){ return $this->sitesManager->getAllSites();}); 140 | 141 | foreach ($allSites as $site) { 142 | if (strpos($url, $site['main_url']) !== false) { 143 | return $site['idsite']; 144 | } 145 | } 146 | 147 | 148 | return false; 149 | } 150 | } -------------------------------------------------------------------------------- /Component/NoCache.php: -------------------------------------------------------------------------------- 1 | shortcodeModel = $shortcodeModel; 24 | } 25 | 26 | /** 27 | * @param string $code 28 | * 29 | * @return string|null 30 | */ 31 | abstract protected function getShortcodeFromCache($code); 32 | 33 | /** 34 | * @param string $code 35 | * @param string $url 36 | */ 37 | abstract protected function storeShortcodeInCache($code, $url); 38 | 39 | /** 40 | * @param string $code 41 | * 42 | * @return array 43 | */ 44 | public function getShortcode($code) 45 | { 46 | $shortcode = $this->getShortcodeFromCache($code); 47 | if ($shortcode === null) { 48 | $shortcode = $this->getUrlFromModel($code); 49 | 50 | if (isset($shortcode['url'])) { 51 | $this->storeShortcodeInCache($code, $shortcode); 52 | } 53 | } 54 | 55 | return $shortcode; 56 | } 57 | 58 | protected function getUrlFromModel($code) 59 | { 60 | return $this->shortcodeModel->selectShortcodeByCode($code); 61 | } 62 | 63 | } -------------------------------------------------------------------------------- /Component/ShortcodeValidator.php: -------------------------------------------------------------------------------- 1 | checkLength($value); 24 | $this->checkAlphaNumerical($value); 25 | } catch (InvalidShortcodeException $e) { 26 | return false; 27 | } 28 | 29 | return true; 30 | } 31 | 32 | private function checkLength($value) 33 | { 34 | if (strlen($value) !== Generator::$SHORTCODE_LENGTH) { 35 | throw new InvalidShortcodeException(sprintf('Invalid shortcode length %s, expected %s', 36 | strlen($value), Generator::$SHORTCODE_LENGTH)); 37 | } 38 | 39 | return true; 40 | } 41 | 42 | private function checkAlphaNumerical($value) 43 | { 44 | if (ctype_digit($value)) { 45 | throw new InvalidShortcodeException('Invalid shortcode - contains only numerical characters'); 46 | } 47 | 48 | if (preg_match('/^[a-zA-Z0-9._]+$/', $value)) { 49 | return true; 50 | } 51 | throw new InvalidShortcodeException('Invalid shortcode - contains non alphanumerical characters'); 52 | } 53 | } -------------------------------------------------------------------------------- /Component/UrlValidator.php: -------------------------------------------------------------------------------- 1 | isValidUrl($value)){ 28 | return true; 29 | } 30 | 31 | return false; 32 | } 33 | 34 | /** 35 | * @param $url 36 | * @return bool 37 | */ 38 | public function isValidUrl($url) { 39 | // First check: is the url just a domain name? (allow a slash at the end) 40 | $_domain_regex = "|^[A-Za-z0-9-]+(\.[A-Za-z0-9-]+)*(\.[A-Za-z]{2,})/?$|"; 41 | if (preg_match($_domain_regex, $url)) { 42 | return true; 43 | } 44 | 45 | // Second: Check if it's a url with a scheme and all 46 | $_regex = '#^([a-z][\w-]+:(?:/{1,3}|[a-z0-9%])|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))$#'; 47 | if (preg_match($_regex, $url, $matches)) { 48 | // pull out the domain name, and make sure that the domain is valid. 49 | $_parts = parse_url($url); 50 | if (!in_array($_parts['scheme'], array( 'http', 'https' ))) 51 | return false; 52 | 53 | // Check the domain using the regex, stops domains like "-example.com" passing through 54 | if (!preg_match($_domain_regex, $_parts['host'])) 55 | return false; 56 | 57 | return true; 58 | } 59 | 60 | return false; 61 | } 62 | } -------------------------------------------------------------------------------- /Component/Validator.php: -------------------------------------------------------------------------------- 1 | getSlashedSetting(ShortcodeTracker::SHORTENER_URL_SETTING); 25 | 26 | $view = new View('@ShortcodeTracker/singleShortcode'); 27 | $codeValidator = new ShortcodeValidator(); 28 | if ($codeValidator->validate($shortcode) === true) { 29 | $view->header = 'ShortcodeTracker_generated_shortcode_is'; 30 | $view->text = $baseUrl . $shortcode; 31 | $view->containerClass = 'alert-success'; 32 | } else { 33 | $view->header = 'ShortcodeTracker_unable_to_generate_shortcode'; 34 | $view->text = 'ShortcodeTracker_provide_valid_url'; 35 | $view->containerClass = 'alert-warning'; 36 | } 37 | 38 | return $view->render(); 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /Exception/InvalidShortcodeException.php: -------------------------------------------------------------------------------- 1 | 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 | -------------------------------------------------------------------------------- /Model/Model.php: -------------------------------------------------------------------------------- 1 | db === null) { 31 | $this->db = Db::get(); 32 | } 33 | 34 | return $this->db; 35 | } 36 | 37 | /** 38 | * @param mixed $db 39 | */ 40 | public function setDb($db) 41 | { 42 | $this->db = $db; 43 | } 44 | 45 | 46 | /** 47 | * @return bool 48 | */ 49 | public function install() 50 | { 51 | $query = "CREATE TABLE IF NOT EXISTS " . Common::prefixTable('shortcode') . " 52 | ( `id` int(11) NOT NULL AUTO_INCREMENT, 53 | `code` varchar(6) NOT NULL, 54 | `url` varchar(512) NOT NULL, 55 | `idsite` int(10) DEFAULT NULL, 56 | PRIMARY KEY(`id`), 57 | UNIQUE KEY `uk_code` (`code`) 58 | ) DEFAULT CHARSET = utf8;"; 59 | 60 | $this->executeQuery('query', $query); 61 | 62 | return true; 63 | } 64 | 65 | /** 66 | * @param string $code 67 | * @param string $url 68 | * @param int $idsite 69 | * 70 | * @return bool 71 | */ 72 | public function insertShortcode($code, $url, $idsite) 73 | { 74 | $this->getDb()->query('INSERT into ' . Common::prefixTable("shortcode") . ' 75 | SET code = ?, url = ?, idsite = ?', array($code, $url, $idsite)); 76 | } 77 | 78 | /** 79 | * @throws /Exception 80 | * @return bool 81 | */ 82 | public function deleteShortcode() 83 | { 84 | return false; 85 | } 86 | 87 | /** 88 | * @param $shortcode 89 | * 90 | * @return string 91 | */ 92 | public function selectShortcodeByCode($shortcode) 93 | { 94 | return $this->getDb()->fetchRow('Select * from ' . Common::prefixTable('shortcode') . ' 95 | where code = ? ORDER BY id DESC LIMIT 1', array($shortcode)); 96 | } 97 | 98 | /** 99 | * @param $url 100 | * 101 | * @return string 102 | */ 103 | public function selectShortcodeByUrl($url) 104 | { 105 | return $this->getDb()->fetchOne('Select code from ' . Common::prefixTable('shortcode') . ' 106 | where url = ? ORDER BY id DESC LIMIT 1', array($url)); 107 | } 108 | 109 | /** 110 | * @param string $method 111 | * @param string $query 112 | * @param array $params 113 | */ 114 | public function executeQuery($method, $query, array $params = array()) 115 | { 116 | $this->getDb()->$method($query, $params); 117 | } 118 | 119 | } -------------------------------------------------------------------------------- /Model/ModelInterface.php: -------------------------------------------------------------------------------- 1 | Plugins, 67 | * find "ShortcodeTracker" plugin and click `enable`, 68 | 69 | After you confirm that plugin has been enabled: 70 | * go to Administration -> Plugin Settings, 71 | * go to ShortcodeTracker section, 72 | * fill in Shortener URL input, 73 | * if you want to track external sites, you need to decide to which Piwik page those actions will be attributed (see 74 | External redirects tracking section below), 75 | * click 'save', 76 | * **additionally you have to make Shortener URL a trusted host for Piwik by entering it in settings section**, 77 | 78 | This is necessary to perform, as otherwise you will not be able to generate shortened URLs or use them with Piwik. 79 | 80 | #### External redirects tracking 81 | 82 | It is possible to also track redirect actions for external URLs (i.e. which URL doesn't match any page tracked within 83 | your Piwik instance). However, it is required to decide to which site this traffic will be attributed to. 84 | 85 | It is recommended to create a separate Website in Piwik instance only dedicated to this traffic, so that other websites 86 | reports won't be affected by redirect events. 87 | 88 | To select which site should collect redirects: 89 | 90 | * go to `Plugin Settings` section, 91 | * from dropdown you can select site for external redirects, 92 | * alternatively you can select not to track external redirects by setting `Do not collect external shortcode redirects`, 93 | * click save 94 | 95 | 96 | 97 | ### Backlog 98 | 99 | * Add advanced report for each shortcode 100 | * stitch every redirect event with following action, 101 | * add new referrer type (shortcode), 102 | * aggregate statistics, 103 | * add segment for referrer, 104 | * Refactor plugin so it's possible to cover Model.php with tests, 105 | * Add queue system for tracking redirect events to improve performance of redirect feature, 106 | * Add integration test for redirect tracking, 107 | * Add support for at least one caching system (redis/memcache), 108 | * Improve HTML elements designs/styles, 109 | * Throw exception/signal in UI in case Shortener URL is not changed, 110 | * Introduce Shortener base URL validation (in Settings section), 111 | * introduce value object to store Shortcode, 112 | * handle case when given idsite has multiple domains assigned (currently it's only for main domain URL), 113 | 114 | 115 | ### Support 116 | 117 | Please direct any feedback regarding plugin to Github repository issue tracker available at 118 | [https://github.com/mgazdzik/plugin-ShortcodeTracker/issues](https://github.com/mgazdzik/plugin-ShortcodeTracker/issues). 119 | 120 | 121 | ### Credits 122 | Scissors icon visible in Actions report is originating from 123 | [https://icons8.com/](https://icons8.com/). 124 | 125 | -------------------------------------------------------------------------------- /Reports/Base.php: -------------------------------------------------------------------------------- 1 | categoryId = 'Shortcodes'; 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /Reports/GetExternalShortcodeUsageReport.php: -------------------------------------------------------------------------------- 1 | name = 'Shortcodes'; 29 | $this->dimension = null; 30 | $this->documentation = Piwik::translate(''); 31 | 32 | // This defines in which order your report appears in the mobile app, in the menu and in the list of widgets 33 | $this->order = 4; 34 | 35 | 36 | $this->subcategoryId = 'External shortcode usage'; 37 | } 38 | 39 | /** 40 | * Here you can configure how your report should be displayed. For instance whether your report supports a search 41 | * etc. You can also change the default request config. For instance change how many rows are displayed by default. 42 | * 43 | * @param ViewDataTable $view 44 | */ 45 | public function configureView(ViewDataTable $view) 46 | { 47 | if (!empty($this->dimension)) { 48 | $view->config->addTranslations(array('label' => $this->dimension->getName())); 49 | } 50 | 51 | // $view->config->show_search = false; 52 | // $view->requestConfig->filter_sort_column = 'nb_visits'; 53 | // $view->requestConfig->filter_limit = 10'; 54 | 55 | $view->config->columns_to_display = array_merge(array('label'), $this->metrics); 56 | } 57 | 58 | /** 59 | * Here you can define related reports that will be shown below the reports. Just return an array of related 60 | * report instances if there are any. 61 | * 62 | * @return \Piwik\Plugin\Report[] 63 | */ 64 | public function getRelatedReports() 65 | { 66 | return array(); // eg return array(new XyzReport()); 67 | } 68 | 69 | /** 70 | * A report is usually completely automatically rendered for you but you can render the report completely 71 | * customized if you wish. Just overwrite the method and make sure to return a string containing the content of the 72 | * report. Don't forget to create the defined twig template within the templates folder of your plugin in order to 73 | * make it work. Usually you should NOT have to overwrite this render method. 74 | * 75 | * @return string 76 | public function render() 77 | { 78 | $view = new View('@ShortcodeTracker/getShortcodes'); 79 | $view->myData = array(); 80 | 81 | return $view->render(); 82 | } 83 | */ 84 | 85 | } 86 | -------------------------------------------------------------------------------- /Reports/GetShortcodeUsageReport.php: -------------------------------------------------------------------------------- 1 | name = 'Shortcodes'; 29 | $this->dimension = null; 30 | $this->documentation = Piwik::translate(''); 31 | 32 | // This defines in which order your report appears in the mobile app, in the menu and in the list of widgets 33 | $this->order = 2; 34 | 35 | 36 | $this->subcategoryId = Piwik::translate('ShortcodeTracker_menu_shortcodeUsageReport'); 37 | } 38 | 39 | /** 40 | * Here you can configure how your report should be displayed. For instance whether your report supports a search 41 | * etc. You can also change the default request config. For instance change how many rows are displayed by default. 42 | * 43 | * @param ViewDataTable $view 44 | */ 45 | public function configureView(ViewDataTable $view) 46 | { 47 | if (!empty($this->dimension)) { 48 | $view->config->addTranslations(array('label' => $this->dimension->getName())); 49 | } 50 | 51 | // $view->config->show_search = false; 52 | // $view->requestConfig->filter_sort_column = 'nb_visits'; 53 | // $view->requestConfig->filter_limit = 10'; 54 | 55 | $view->config->columns_to_display = array_merge(array('label'), $this->metrics); 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /Reports/GetShortenedExternalPagesReport.php: -------------------------------------------------------------------------------- 1 | name = 'Shortcodes'; 29 | $this->dimension = null; 30 | $this->documentation = Piwik::translate(''); 31 | 32 | // This defines in which order your report appears in the mobile app, in the menu and in the list of widgets 33 | $this->order = 5; 34 | 35 | 36 | $this->subcategoryId = 'Most shortened external pages'; 37 | } 38 | 39 | /** 40 | * Here you can configure how your report should be displayed. For instance whether your report supports a search 41 | * etc. You can also change the default request config. For instance change how many rows are displayed by default. 42 | * 43 | * @param ViewDataTable $view 44 | */ 45 | public function configureView(ViewDataTable $view) 46 | { 47 | if (!empty($this->dimension)) { 48 | $view->config->addTranslations(array('label' => $this->dimension->getName())); 49 | } 50 | 51 | // $view->config->show_search = false; 52 | // $view->requestConfig->filter_sort_column = 'nb_visits'; 53 | // $view->requestConfig->filter_limit = 10'; 54 | 55 | $view->config->columns_to_display = array_merge(array('label'), $this->metrics); 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /Reports/GetShortenedPagesReport.php: -------------------------------------------------------------------------------- 1 | name = 'Shortcodes'; 29 | $this->dimension = null; 30 | $this->documentation = Piwik::translate(''); 31 | 32 | // This defines in which order your report appears in the mobile app, in the menu and in the list of widgets 33 | $this->order = 3; 34 | 35 | 36 | $this->subcategoryId = 'Most shortened pages'; 37 | } 38 | 39 | /** 40 | * Here you can configure how your report should be displayed. For instance whether your report supports a search 41 | * etc. You can also change the default request config. For instance change how many rows are displayed by default. 42 | * 43 | * @param ViewDataTable $view 44 | */ 45 | public function configureView(ViewDataTable $view) 46 | { 47 | if (!empty($this->dimension)) { 48 | $view->config->addTranslations(array('label' => $this->dimension->getName())); 49 | } 50 | 51 | // $view->config->show_search = false; 52 | // $view->requestConfig->filter_sort_column = 'nb_visits'; 53 | // $view->requestConfig->filter_limit = 10'; 54 | 55 | $view->config->columns_to_display = array_merge(array('label'), $this->metrics); 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /ShortcodeTracker.php: -------------------------------------------------------------------------------- 1 | install(); 31 | } 32 | 33 | /** 34 | * @return array 35 | */ 36 | public function registerEvents() 37 | { 38 | return array( 39 | 'API.DocumentationGenerator.@hideForAll' => 'hideForAll', 40 | 'AssetManager.getJavaScriptFiles' => 'getJsFiles', 41 | 'AssetManager.getStylesheetFiles' => 'getStylesheetFiles', 42 | 'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys', 43 | self::TRACK_REDIRECT_VISIT_EVENT => 'trackRedirectAction', 44 | 'ViewDataTable.configure' => 'dataTableConfigure', 45 | ); 46 | } 47 | 48 | /** 49 | * @param bool $hide 50 | */ 51 | public function hideForAll(&$hide) 52 | { 53 | $hide = true; 54 | } 55 | 56 | /** 57 | * @param array $jsFiles 58 | */ 59 | public function getJsFiles(&$jsFiles) 60 | { 61 | $jsFiles[] = "plugins/ShortcodeTracker/javascripts/rowaction.js"; 62 | $jsFiles[] = "plugins/ShortcodeTracker/javascripts/shortcodeGenerating.js"; 63 | } 64 | 65 | /** 66 | * @param array $translationKeys 67 | */ 68 | public function getClientSideTranslationKeys(&$translationKeys) 69 | { 70 | $translationKeys[] = 'ShortcodeTracker_generated_shortcode_is'; 71 | $translationKeys[] = 'ShortcodeTracker_rowaction_tooltip_title'; 72 | $translationKeys[] = 'ShortcodeTracker_rowaction_tooltip'; 73 | } 74 | 75 | /** 76 | * @param array $stylesheets 77 | */ 78 | public function getStylesheetFiles(&$stylesheets) 79 | { 80 | $stylesheets[] = "plugins/ShortcodeTracker/stylesheets/styles.less"; 81 | } 82 | 83 | /** 84 | * @param array $shortcode 85 | */ 86 | public function trackRedirectAction($shortcode) 87 | { 88 | $tracker = new RedirectTracker(); 89 | $tracker->recordRedirectAction($shortcode); 90 | } 91 | 92 | public function dataTableConfigure(ViewDataTable $view) 93 | { 94 | if ( 95 | ($view->requestConfig->apiMethodToRequestDataTable === 'ShortcodeTracker.getShortcodeUsageReport') 96 | || $view->requestConfig->apiMethodToRequestDataTable === 'ShortcodeTracker.getExternalShortcodeUsageReport' 97 | || $view->requestConfig->apiMethodToRequestDataTable === 'ShortcodeTracker.getShortenedExternalPagesReport' 98 | || $view->requestConfig->apiMethodToRequestDataTable === 'ShortcodeTracker.getShortenedPagesReport' 99 | 100 | ) { 101 | $view->config->show_insights = false; 102 | $view->config->disable_row_evolution = true; 103 | $view->config->show_all_views_icons = false; 104 | } 105 | } 106 | } 107 | -------------------------------------------------------------------------------- /SystemSettings.php: -------------------------------------------------------------------------------- 1 | metric->getValue(); 23 | * $settings->description->getValue(); 24 | */ 25 | class SystemSettings extends \Piwik\Settings\Plugin\SystemSettings 26 | { 27 | /** 28 | * @var Setting 29 | */ 30 | public $shortenerUrl; 31 | 32 | /** 33 | * @var Setting 34 | */ 35 | public $shortenerExternalShortcodeIdsite; 36 | 37 | protected function init() 38 | { 39 | $this->shortenerUrl = $this->createShortenerUrlSetting(); 40 | $this->shortenerExternalShortcodeIdsite = $this->getShortenerIdsiteForExternalShortcodesSetting(); 41 | } 42 | public function getSlashedSetting($name) 43 | { 44 | $setting = parent::getSetting($name); 45 | $value = $setting->getValue() ?? ''; 46 | if (substr($value, -1) !== '/') { 47 | return $value . "/"; 48 | } 49 | return $value; 50 | } 51 | 52 | private function createShortenerUrlSetting() 53 | { 54 | return $this->makeSetting( 55 | ShortcodeTracker::SHORTENER_URL_SETTING, 56 | $default = null, 57 | FieldConfig::TYPE_STRING, 58 | function (FieldConfig $field) { 59 | $field->title = Piwik::translate('ShortcodeTracker_settings_shortener_url_setting_name'); 60 | $field->description = Piwik::translate('ShortcodeTracker_settings_shortener_url_setting_description'); 61 | $field->uiControl = FieldConfig::UI_CONTROL_TEXT; 62 | $field->description = 'If enabled, the value will be automatically refreshed depending on the specified interval'; 63 | } 64 | ); 65 | 66 | } 67 | 68 | 69 | private function getShortenerIdsiteForExternalShortcodesSetting() 70 | { 71 | return $this->makeSetting( 72 | ShortcodeTracker::SHORTENER_EXTERNAL_SHORTCODES_IDSITE, 73 | null, 74 | FieldConfig::TYPE_INT, 75 | function (FieldConfig $field) { 76 | $field->title = Piwik::translate('ShortcodeTracker_settings_shortener_external_shortcodes_idsite_setting_name'); 77 | $field->description = Piwik::translate('ShortcodeTracker_settings_shortener_external_shortcodes_idsite_setting'); 78 | $field->uiControl = FieldConfig::UI_CONTROL_SINGLE_SELECT; 79 | $sitesManagerApi = SitesManagerAPI::getInstance(); 80 | $field->availableValues = Access::doAsSuperUser(function () use ($sitesManagerApi) { 81 | $sites = $sitesManagerApi->getAllSites(); 82 | $siteIds = array('0' => 'Do not collect external shortcode redirects'); 83 | foreach ($sites as $site) { 84 | $siteIds[$site['idsite']] = $site['name']; 85 | } 86 | 87 | return $siteIds; 88 | }); 89 | } 90 | ); 91 | } 92 | } 93 | -------------------------------------------------------------------------------- /Tracker/RedirectTracker.php: -------------------------------------------------------------------------------- 1 | shortcodeTrackerSettings = new SystemSettings('ShortcodeTracker'); 18 | } 19 | 20 | public function recordRedirectAction($shortcode) 21 | { 22 | $baseUrl = $this->shortcodeTrackerSettings->getSlashedSetting(ShortcodeTracker::SHORTENER_URL_SETTING); 23 | 24 | $idSite = $this->getIdsiteForShortcode($shortcode); 25 | if ($idSite !== "0") { 26 | $piwikTracker = $this->getPiwikTracker($idSite); 27 | $piwikTracker->setUrl($shortcode['url']); 28 | $piwikTracker->setUrlReferrer($baseUrl . $shortcode['code']); 29 | $result = $piwikTracker->doTrackEvent(ShortcodeTracker::REDIRECT_EVENT_CATEGORY, 30 | ShortcodeTracker::REDIRECT_EVENT_NAME, 31 | $shortcode['code']); 32 | 33 | Log::debug($result); 34 | } 35 | } 36 | 37 | protected function getPiwikTracker($idSite) 38 | { 39 | require_once PIWIK_INCLUDE_PATH . '/libs/PiwikTracker/PiwikTracker.php'; 40 | \PiwikTracker::$URL = SettingsPiwik::getPiwikUrl(); 41 | 42 | return new \PiwikTracker($idSite); 43 | } 44 | 45 | protected function getIdsiteForShortcode($shortcode) 46 | { 47 | if ((int)$shortcode['idsite'] !== 0) { 48 | return $shortcode['idsite']; 49 | } else { 50 | return $this->shortcodeTrackerSettings 51 | ->getSetting(ShortcodeTracker::SHORTENER_EXTERNAL_SHORTCODES_IDSITE)->getValue(); 52 | } 53 | } 54 | 55 | } 56 | -------------------------------------------------------------------------------- /Widgets/GetShortcodegenerator.php: -------------------------------------------------------------------------------- 1 | setCategoryId('Shortcodes'); 31 | 32 | /** 33 | * Set the subcategory the widget belongs to. If a subcategory is set, the widget will be shown in the UI. 34 | */ 35 | $config->setSubcategoryId('ShortcodeTracker_menu_generateShortcode'); 36 | 37 | /** 38 | * Set the name of the widget belongs to. 39 | */ 40 | $config->setName('ShortcodeTracker_Shortcodegenerator'); 41 | 42 | /** 43 | * Set the order of the widget. The lower the number, the earlier the widget will be listed within a category. 44 | */ 45 | $config->setOrder(99); 46 | 47 | /** 48 | * Optionally set URL parameters that will be used when this widget is requested. 49 | * $config->setParameters(array('myparam' => 'myvalue')); 50 | */ 51 | 52 | if (Piwik::isUserHasSomeWriteAccess() === false) { 53 | $config->disable(); 54 | } 55 | /** 56 | * Define whether a widget is enabled or not. For instance some widgets might not be available to every user or 57 | * might depend on a setting (such as Ecommerce) of a site. In such a case you can perform any checks and then 58 | * set `true` or `false`. If your widget is only available to users having super user access you can do the 59 | * following: 60 | * 61 | * $config->setIsEnabled(\Piwik\Piwik::hasUserSuperUserAccess()); 62 | * or 63 | * if (!\Piwik\Piwik::hasUserSuperUserAccess()) 64 | * $config->disable(); 65 | */ 66 | } 67 | 68 | /** 69 | * This method renders the widget. It's on you how to generate the content of the widget. 70 | * As long as you return a string everyting is fine. You can use for instance a "Piwik\View" to render a 71 | * twig template. In such a case don't forget to create a twig template (eg. myViewTemplate.twig) in the 72 | * "templates" directory of your plugin.h 73 | * 74 | * @return string 75 | */ 76 | public function render() 77 | { 78 | // or: return $this->renderTemplate('myViewTemplate', array(...view variables...)); 79 | return $this->renderTemplate('index'); 80 | } 81 | 82 | } -------------------------------------------------------------------------------- /changelog.md: -------------------------------------------------------------------------------- 1 | ## Changelog 2 | 3 | * 3.0.0 4 | * Added compatibility with Matomo 5.x - thanks to @snake14 5 | 6 | * 2.0.3 7 | * Fixed bug where API tried to access not existing subtable 8 | 9 | * 2.0.2 10 | * Fix external redirect tracking error due to wrong type casting in PHP 11 | 12 | * 2.0.1 13 | * Loosen up validation of new shortcodes generation for users with Write permission to External Shortcodes Site (previously it would require SuperAdmin access) 14 | 15 | * 2.0.0 16 | * Updated plugin to work with latest Matomo version 17 | 18 | * 1.2.0 19 | * add proper LICENSE file to codebase 20 | 21 | * 1.1.8 22 | * Fix Apache .htaccess example file 23 | 24 | * 1.1.5, 1.1.4, 1.1.3 25 | 26 | * minor tweaks in plugin compatibility with Matomo plugin Marketplace 27 | 28 | * 1.1.2 29 | * Force update of plugin in Matomo plugin Marketplace 30 | 31 | * 1.1.1 32 | * Fix generating reports and shortcodes for admin users 33 | 34 | * 1.1.0 35 | * Attempt to limit shortcode generation to only admin access users 36 | 37 | * 1.0.0 38 | * Updated plugin to work with Piwik 3.x 39 | 40 | * 0.7.0 41 | * Handled html-encoded entities in URLs (for ex. http://example.com?param1=foo¶m2=bar was html encoded and therefore it was breaking redirects) 42 | * Added some screenshots for Marketplace 43 | 44 | * 0.6.2 45 | * Sort out mistakenly pushed tag 46 | 47 | 48 | * 0.6.0 49 | * Shortcode usage report added link to shortened page to for easier recognition of what is being shortened and used most, 50 | * Display summarized report displaying which URLs were visited most via shortcode redirects, 51 | 52 | 53 | * 0.5.0 54 | * Add statistics collection for redirects to pages not tracked with Piwik (external pages) 55 | * collect redirect statistics into Site you choose in interface, 56 | * aggregate and display report for external shortcodes in separate view 57 | 58 | 59 | * 0.4.5 60 | * fix README formating for sake of Plugin market 61 | 62 | 63 | * 0.4.4 64 | * add license to plugin.json 65 | 66 | 67 | * 0.4.3 68 | * fix plugin.json structure for Plugin market 69 | 70 | 71 | * 0.4.2 72 | * Added missing changelog 73 | 74 | 75 | * 0.4.0 76 | * Piwik Plugin market release 77 | 78 | 79 | * 0.3.0 80 | * Tuned travis build file 81 | * Mark Shortcodes as internal during creating 82 | * Track custom event with "redirect" category upon each redirect for internal Shortcode 83 | * Secure API methods from anonymous user usage 84 | * Add shortcode report for internally tracked URLs: 85 | * Create new visit during redirect (store referrer) 86 | * Add Shortcode usage report based on Custom Events plugin API 87 | 88 | 89 | * 0.2.0 90 | * added Travis build badges for master and develop branches 91 | * fixed existing unit tests 92 | * slight refactor in terms of class naming 93 | * added integration test for API methods 94 | 95 | 96 | * 0.1.0 97 | * API allowing to create and retrieve shortcodes, 98 | * basic storage in MySQL, but possible to add other caching layers - for ex. Memcache, Redis, 99 | * unit tests covering core logic, 100 | * redirect API method that will preform appropriate redirects for incoming shortcode requests, 101 | * basic setup guide involving Apache2 and Nginx configs, 102 | * settings section allowing user to configure Shortener base URL (which may and should be different than Piwik instance) 103 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "mgazdzik/plugin-ShortcodeTracker", 3 | "type": "piwik-plugin", 4 | "description": "Piwik plugin allowing user to create shortcodes and track their usage within Piwik. Also integrates with UI to deliver more user-friendly interaction.", 5 | "keywords": ["shortcode","shortener","tracker"], 6 | "homepage": "http://mgazdzik.pl", 7 | "license": "LGPL-3.0+", 8 | "authors": [ 9 | { 10 | "name": "Michał Gaździk", 11 | "email": "michal@mgazdzik.pl", 12 | "homepage": "http://mgazdzik.pl" 13 | } 14 | ], 15 | "require": { 16 | "piwik/piwik": ">=4.1.0", 17 | "piwik/piwik-php-tracker": "dev-master" 18 | } 19 | } -------------------------------------------------------------------------------- /docs/apache_config.txt: -------------------------------------------------------------------------------- 1 | # BEGIN Matomo Short URL put in .htaccsss 2 | 3 | RewriteEngine On 4 | RewriteCond %{REQUEST_FILENAME} !-f 5 | RewriteCond %{REQUEST_FILENAME} !-d 6 | RewriteBase / 7 | RewriteRule ^([a-zA-Z0-9]{6})$ /index.php?module=API&method=ShortcodeTracker.performRedirectForShortcode&code=$1 [L] 8 | 9 | # END Matomo Short URL 10 | -------------------------------------------------------------------------------- /docs/nginx_config.txt: -------------------------------------------------------------------------------- 1 | server { 2 | listen 80; 3 | 4 | root {piwik_root_path}; 5 | index index.php; 6 | 7 | server_name {shortener_url}; 8 | 9 | rewrite "^\/([a-zA-Z0-9]{6})$" /index.php?module=API&method=ShortcodeTracker.performRedirectForShortcode&code=$1; 10 | 11 | location / { 12 | index index.php; 13 | } 14 | 15 | error_page 404 /404.html; 16 | 17 | error_page 500 502 503 504 /50x.html; 18 | location = /50x.html { 19 | root /usr/share/nginx/www; 20 | } 21 | 22 | # pass the PHP scripts to FastCGI server listening on the php-fpm socket 23 | location ~ \.php$ { 24 | try_files $uri =404; 25 | fastcgi_pass unix:/var/run/php5-fpm.sock; 26 | fastcgi_index index.php; 27 | fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; 28 | include fastcgi_params; 29 | 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /images/shorten_icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mgazdzik/plugin-ShortcodeTracker/9ebf7f2213a8e3c226ca72ea49b179365cf52f99/images/shorten_icon.png -------------------------------------------------------------------------------- /images/shorten_icon_hover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mgazdzik/plugin-ShortcodeTracker/9ebf7f2213a8e3c226ca72ea49b179365cf52f99/images/shorten_icon_hover.png -------------------------------------------------------------------------------- /javascripts/rowaction.js: -------------------------------------------------------------------------------- 1 | function DataTable_RowActions_Shortener(dataTable) { 2 | this.dataTable = dataTable; 3 | } 4 | 5 | DataTable_RowActions_Shortener.prototype = new DataTable_RowAction; 6 | 7 | DataTable_RowActions_Shortener.prototype.trigger = function (tr, e, subTableLabel) { 8 | var link = $(tr).data('urlLabel'); 9 | var useExistingCodeIfAvailable = true; 10 | getShortcodeAndShowPopup(link, useExistingCodeIfAvailable); 11 | } 12 | 13 | 14 | DataTable_RowActions_Registry.register({ 15 | 16 | name: 'Shorten URL', 17 | 18 | dataTableIcon: 'plugins/ShortcodeTracker/images/shorten_icon.png', 19 | dataTableIconHover: 'plugins/ShortcodeTracker/images/shorten_icon_hover.png', 20 | 21 | order: 70, 22 | 23 | dataTableIconTooltip: [ 24 | _pk_translate('ShortcodeTracker_rowaction_tooltip_title'), 25 | _pk_translate('ShortcodeTracker_rowaction_tooltip') 26 | ], 27 | 28 | createInstance: function (dataTable) { 29 | return new DataTable_RowActions_Shortener(dataTable); 30 | }, 31 | 32 | isAvailableOnReport: function (dataTableParams) { 33 | return DataTable_RowActions_Transitions.isPageUrlReport(dataTableParams.module, dataTableParams.action); 34 | }, 35 | 36 | isAvailableOnRow: function (dataTableParams, tr) { 37 | var dataUrl = $(tr).data('url-label'); 38 | return typeof dataUrl !== 'undefined' && dataUrl.length > 0; 39 | } 40 | 41 | }); 42 | -------------------------------------------------------------------------------- /javascripts/shortcodeGenerating.js: -------------------------------------------------------------------------------- 1 | function generateShortcodeAjax() { 2 | 3 | var urlToShorten = $('#url_to_shorten').val(); 4 | var useExistingCodeIfAvailable = $("#useExistingShortcodeIfAvailable").prop("checked"); 5 | getShortcodeAndShowPopup(urlToShorten, useExistingCodeIfAvailable); 6 | } 7 | 8 | function getShortcodeAndShowPopup(url, useExistingCodeIfAvailable) { 9 | var postParams = {}; 10 | postParams.url = url; 11 | postParams.useExistingCodeIfAvailable = useExistingCodeIfAvailable; 12 | postParams.tokenAuth = piwik.token_auth; 13 | var ajaxHandler = new ajaxHelper(); 14 | ajaxHandler.addParams({ 15 | module: 'API', 16 | format: 'json', 17 | method: 'ShortcodeTracker.generateShortcodeForUrl' 18 | }, 'GET'); 19 | ajaxHandler.addParams(postParams, 'POST'); 20 | ajaxHandler.setLoadingElement('#ajaxLoadingShortcodeTracker'); 21 | ajaxHandler.setErrorElement('#ajaxErrorShortcodeTrakcer'); 22 | ajaxHandler.setCallback(displayPopup) 23 | ajaxHandler.send(false); 24 | } 25 | 26 | function displayPopup(response) { 27 | var url = 'module=ShortcodeTracker&action=showShortcodePopup&shortcode=' + response.value; 28 | Piwik_Popover.createPopupAndLoadUrl(url, 'details'); 29 | } 30 | 31 | $(document).ready(function () { 32 | $(document).on('click', '#url_to_shorten_submit', function () { 33 | generateShortcodeAjax(); 34 | }); 35 | }); -------------------------------------------------------------------------------- /lang/en.json: -------------------------------------------------------------------------------- 1 | { 2 | "ShortcodeTracker": { 3 | "Topshortcodes": "Top shortcodes", 4 | "unable_to_generate_shortcode": "Unable to generate shortcode.", 5 | "provide_valid_url": "Please try again providing valid URL.", 6 | "unable_to_perform_redirect": "Oops, couldn't complete redirect! Please try using valid shortcode.", 7 | "invalid_shortcode": "Invalid shortcode.", 8 | "generate_shortcode_header": "Shortcode generator", 9 | "url_to_shorten": "Provide URL to be shortened", 10 | "input_url": "URL to shorten", 11 | "generate_shortcode": "Generate shortcode", 12 | "generated_shortcode_is": "Your shortcode is ready to use!", 13 | "rowaction_tooltip_title": "Shorten URL", 14 | "rowaction_tooltip": "Click to instantly generate shortened URL for this page", 15 | "use_existing_shortcode_if_available": "Use existing shortcode if possible", 16 | "use_existing_shortcode_help": "Will return most recently created shortcode found for this URL", 17 | "settings_introduction": "You can specify base URL for your Shortener URL.", 18 | "settings_shortener_url_setting_name": "Shortener URL", 19 | "settings_shortener_external_shortcodes_idsite_setting_name": "Site id for tracking external shortcode redirects", 20 | "settings_shortener_url_setting_description": "URL to be prepended to shortcodes generated by ShortcodeTracker plugin.", 21 | "settings_shortener_external_shortcodes_idsite_setting": "SiteId to which redirects of external Shortcodes will be tracked to.", 22 | "menu_generateShortcode": "Generate Shortcode", 23 | "menu_shortcodeUsageReport": "Shortcode usage report", 24 | "shortcodeUrl_report_column": "Shortened URL", 25 | "Shortcodes": "Shortcodes", 26 | "Shortcodegenerator": "Shortcode generator" 27 | } 28 | } -------------------------------------------------------------------------------- /plugin.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ShortcodeTracker", 3 | "version": "3.0.0", 4 | "description": "Plugin allowing user to create shortcodes and track their usage within Piwik. Also integrates with UI to deliver user-friendly interaction.", 5 | "theme": false, 6 | "keywords": [ 7 | "shortcode", 8 | "shortener", 9 | "redirect" 10 | ], 11 | "require": { 12 | "matomo": ">=5.0.0-b1,<6.0.0-b1" 13 | }, 14 | "license": "GPL-3.0", 15 | "homepage": "http:\/\/mgazdzik.pl\/shortcodetracker", 16 | "authors": [ 17 | { 18 | "name": "Micha\u0142 Ga\u017adzik", 19 | "email": "michal.gazdzik@gmail.com", 20 | "homepage": "http:\/\/mgazdzik.pl" 21 | } 22 | ] 23 | } 24 | -------------------------------------------------------------------------------- /screenshots/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mgazdzik/plugin-ShortcodeTracker/9ebf7f2213a8e3c226ca72ea49b179365cf52f99/screenshots/.gitkeep -------------------------------------------------------------------------------- /screenshots/screenshot1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mgazdzik/plugin-ShortcodeTracker/9ebf7f2213a8e3c226ca72ea49b179365cf52f99/screenshots/screenshot1.png -------------------------------------------------------------------------------- /screenshots/screenshot2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mgazdzik/plugin-ShortcodeTracker/9ebf7f2213a8e3c226ca72ea49b179365cf52f99/screenshots/screenshot2.png -------------------------------------------------------------------------------- /screenshots/screenshot3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mgazdzik/plugin-ShortcodeTracker/9ebf7f2213a8e3c226ca72ea49b179365cf52f99/screenshots/screenshot3.png -------------------------------------------------------------------------------- /screenshots/screenshot4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mgazdzik/plugin-ShortcodeTracker/9ebf7f2213a8e3c226ca72ea49b179365cf52f99/screenshots/screenshot4.png -------------------------------------------------------------------------------- /stylesheets/styles.less: -------------------------------------------------------------------------------- 1 | #single_shortcode { 2 | width: 100%; 3 | } 4 | 5 | #single_shortcode p { 6 | padding: 10px 0px; 7 | } -------------------------------------------------------------------------------- /templates/index.twig: -------------------------------------------------------------------------------- 1 | {% block content %} 2 |
3 |

{{ 'ShortcodeTracker_generate_shortcode_header'|translate }}

4 |
5 |
9 |
10 | 11 |
15 |
16 | 17 | 18 | 19 | 21 |
22 |
23 | {% import 'ajaxMacros.twig' as ajax %} 24 | {{ ajax.errorDiv('ajaxErrorShortcodeTrakcer') }} 25 | {{ ajax.loadingDiv('ajaxLoadingShortcodeTracker') }} 26 | 27 | {% endblock %} 28 | -------------------------------------------------------------------------------- /templates/singleShortcode.twig: -------------------------------------------------------------------------------- 1 |
2 | {{ header|translate }} 3 |

{{ text|translate }}

4 |
-------------------------------------------------------------------------------- /tests/Integration/ShortcodeApiTest.php: -------------------------------------------------------------------------------- 1 | setSuperUserAccess(true); 47 | $this->initializeModelMock(); 48 | $this->initializeSitesManagerAPI(); 49 | $this->api = new API(); 50 | $this->api->setModel($this->modelMock); 51 | $this->api->setSitesManagerAPI($this->sitesManagerApi); 52 | } 53 | 54 | public function testGenerateShortenedUrl() 55 | { 56 | $expected = 'http://changeme.com/123abc'; 57 | try { 58 | $this->api->setGenerator($this->getGeneratorMock('generateShortcode', '123abc')); 59 | 60 | /** @var SystemSettings $pluginSettingsMock */ 61 | $pluginSettingsMock = $this->getMockBuilder('Piwik\Plugins\ShortcodeTracker\SystemSettings') 62 | ->disableOriginalConstructor() 63 | ->getMock(); 64 | 65 | $pluginSettingsMock->expects($this->once()) 66 | ->method('getSetting') 67 | ->with(ShortcodeTracker::SHORTENER_URL_SETTING) 68 | ->willReturn(ShortcodeTracker::DEFAULT_SHORTENER_URL); 69 | 70 | $this->api->setPluginSettings($pluginSettingsMock); 71 | 72 | 73 | $actual = $this->api->generateShortenedUrl('http://foo.bar'); 74 | } catch (\Zend_Db_Statement_Exception $e) { 75 | $this->markTestSkipped('No database connection, skip test'); 76 | } 77 | 78 | $this->assertEquals($expected, $actual); 79 | } 80 | 81 | public function testGenerateShortcodeForUrl() 82 | { 83 | $expected = 'abc123'; 84 | 85 | $this->api->setGenerator($this->getGeneratorMock('generateShortcode', $expected)); 86 | 87 | $actual = $this->api->generateShortcodeForUrl('http://foo.bar'); 88 | 89 | $this->assertEquals($expected, $actual); 90 | } 91 | 92 | 93 | /** 94 | * @dataProvider invalidUrlProvider 95 | */ 96 | public function testGenerateShortcodeForUrlException($invalidUrl) 97 | { 98 | $expected = 'Unable to generate shortcode.'; 99 | $this->api->setGenerator(new Generator( 100 | $this->modelMock, 101 | new UrlValidator(), 102 | new ShortcodeValidator(), 103 | $this->sitesManagerApi) 104 | ); 105 | 106 | $actual = $this->api->generateShortcodeForUrl($invalidUrl); 107 | 108 | $this->assertEquals($expected, $actual); 109 | } 110 | 111 | 112 | public function invalidUrlProvider() 113 | { 114 | return array( 115 | array('invalidUrl'), 116 | array('http://'), 117 | array('file://c:/windows/myfile'), 118 | array('http://foo'), 119 | ); 120 | } 121 | 122 | 123 | private function initializeModelMock() 124 | { 125 | $mock = $this->getMockBuilder('Piwik\Plugins\ShortcodeTracker\Model\Model')->disableOriginalConstructor()->getMock(); 126 | 127 | $this->modelMock = $mock; 128 | } 129 | 130 | private function initializeSitesManagerAPI() 131 | { 132 | $mock = $this->getMockBuilder('Piwik\Plugins\SitesManager\API') 133 | ->disableOriginalConstructor() 134 | ->getMock(); 135 | 136 | $mock->expects($this->any()) 137 | ->method('getAllSites') 138 | ->willReturn(array( 139 | array( 140 | 'idsite' => 1, 141 | 'main_url' => 'http://foo.bar', 142 | ), 143 | )); 144 | $this->sitesManagerApi = $mock; 145 | } 146 | 147 | public function testGetUrlFromShortcode() 148 | { 149 | $expected = array('url' => 'http://foo.bar'); 150 | $this->modelMock->expects($this->once()) 151 | ->method('selectShortcodeByCode') 152 | ->with('123abc') 153 | ->willReturn($expected); 154 | 155 | $actual = $this->api->getUrlFromShortcode('123abc'); 156 | 157 | $this->assertEquals('http://foo.bar', $actual); 158 | } 159 | 160 | public function testGetUrlFromShortcodeFailure() 161 | { 162 | $this->modelMock->expects($this->any()) 163 | ->method('selectShortcodeByCode') 164 | ->willReturn(null); 165 | 166 | 167 | $actual = $this->api->getUrlFromShortcode('456zxc'); 168 | 169 | $this->assertEquals('Invalid shortcode.', $actual); 170 | } 171 | 172 | public function testPerformRedirectForShortcode() 173 | { 174 | $this->modelMock->expects($this->once()) 175 | ->method('selectShortcodeByCode') 176 | ->with('123zxc') 177 | ->willReturn( 178 | [ 179 | 'url' => 'http://foo.bar', 180 | 'idsite' => 1, 181 | 'code' => '123zxc' 182 | ] 183 | ); 184 | 185 | try { 186 | $this->api->performRedirectForShortcode('123zxc'); 187 | } catch (\Exception $e) { 188 | $this->assertContains('Cannot modify header information - headers already sent by', $e->getMessage()); 189 | } 190 | 191 | } 192 | 193 | public function testPerformRedirectForShortcodeFailure() 194 | { 195 | $this->modelMock->expects($this->once()) 196 | ->method('selectShortcodeByCode') 197 | ->willReturn(null); 198 | $this->setExpectedException('Piwik\Plugins\ShortcodeTracker\Exception\UnableToRedirectException', 199 | 'Oops, couldn\'t complete redirect! Please try using valid shortcode.'); 200 | 201 | $this->api->performRedirectForShortcode('123zxc'); 202 | } 203 | 204 | public function testHtmlEncodedEntitiesStoredProperly() 205 | { 206 | $api = new API(); 207 | $model = new Model(); 208 | $api->setModel($model); 209 | $api->setSitesManagerAPI($this->sitesManagerApi); 210 | 211 | $url = 'http://example.com?param1=foo&param2=bar'; 212 | 213 | $code = $api->generateShortcodeForUrl($url); 214 | 215 | $resultUrl = $api->getUrlFromShortcode($code); 216 | 217 | $this->assertEquals(html_entity_decode($url), $resultUrl); 218 | } 219 | 220 | /** 221 | * @param $methodName 222 | * @param $returnValue 223 | * 224 | * @return Generator 225 | */ 226 | private function getGeneratorMock($methodName, $returnValue) 227 | { 228 | $generatorMock = $this->getMockBuilder('Piwik\Plugins\ShortcodeTracker\Component\Generator')->disableOriginalConstructor()->getMock(); 229 | $generatorMock->expects($this->once()) 230 | ->method($methodName) 231 | ->willReturn($returnValue); 232 | 233 | return $generatorMock; 234 | } 235 | } 236 | -------------------------------------------------------------------------------- /tests/Unit/ShortcodeGeneratorTest.php: -------------------------------------------------------------------------------- 1 | getModelMockWithResponse($modelMockValue); 36 | $urlValidator = new UrlValidator(); 37 | $shortcodeValidator = new ShortcodeValidator(); 38 | $sitesManagerAPI = $this->getSitesManagerAPIMock(); 39 | $this->component = new Generator($modelMock, $urlValidator,$shortcodeValidator, $sitesManagerAPI); 40 | $actual = $this->component->generateShortcode($url); 41 | $this->assertNotEmpty($actual); 42 | $this->assertEquals(6, strlen($actual)); 43 | } 44 | 45 | 46 | /** 47 | * @return array 48 | */ 49 | public function generateShortcodeProvider() 50 | { 51 | return array( 52 | array('http://www.piwik.org', false), 53 | array('http://www.johndoe.com', false), 54 | ); 55 | } 56 | 57 | public function testCheckIfUnique() 58 | { 59 | $modelMock = $this->getModelMockForUniqueTest(); 60 | $urlValidator = new UrlValidator(); 61 | $shortcodeValidator = $this->getMock(ShortcodeValidator::class); 62 | $shortcodeValidator->method('validate')->willReturn(true); 63 | $sitesManagerAPI = $this->getSitesManagerAPIMock(); 64 | $this->component = new Generator($modelMock, $urlValidator, $shortcodeValidator, $sitesManagerAPI); 65 | 66 | $actual = array(); 67 | $actual[] = $this->component->generateShortcode('http://www.piwik.org'); 68 | $actual[] = $this->component->generateShortcode('http://www.piwik.org'); 69 | 70 | $this->assertNotEquals($actual[0], $actual[1]); 71 | } 72 | 73 | public function testGetIdSiteForUrl() 74 | { 75 | $modelMock = $this->getModelMockWithResponse(''); 76 | $urlValidator = new UrlValidator(); 77 | $shortcodeValidator = new ShortcodeValidator(); 78 | $sitesManagerAPI = $this->getSitesManagerAPIMock(); 79 | $this->component = new Generator($modelMock, $urlValidator, $shortcodeValidator, $sitesManagerAPI); 80 | 81 | $idsite = $this->component->getIdSiteForUrl('https://bar.foo'); 82 | $this->assertEquals(2, $idsite); 83 | } 84 | 85 | private function getModelMockForUniqueTest() 86 | { 87 | $mock = $this->getMockBuilder('Piwik\Plugins\ShortcodeTracker\Model\Model') 88 | ->disableOriginalConstructor() 89 | ->getMock(); 90 | 91 | $mock->expects($this->at(0)) 92 | ->method('selectShortcodeByCode') 93 | ->will($this->returnValue(true)); 94 | 95 | $mock->expects($this->at(1)) 96 | ->method('selectShortcodeByCode') 97 | ->will($this->returnValue(false)); 98 | 99 | $mock->expects($this->at(2)) 100 | ->method('selectShortcodeByCode') 101 | ->will($this->returnValue(true)); 102 | 103 | return $mock; 104 | } 105 | 106 | /** 107 | * @return \PHPUnit_Framework_MockObject_MockObject 108 | */ 109 | private function getModelMockWithResponse($response) 110 | { 111 | $mock = $this->getMockBuilder('Piwik\Plugins\ShortcodeTracker\Model\Model') 112 | ->disableOriginalConstructor() 113 | ->setMethods(array('selectShortcodeByCode')) 114 | ->getMock(); 115 | 116 | $mock->expects($this->any()) 117 | ->method('selectShortcodeByCode') 118 | ->will($this->returnValue($response)); 119 | 120 | return $mock; 121 | } 122 | 123 | private function getSitesManagerAPIMock() 124 | { 125 | $mock = $this->getMockBuilder('Piwik\Plugins\SitesManager\API') 126 | ->disableOriginalConstructor() 127 | ->getMock(); 128 | 129 | $sitesCollection = array( 130 | array('idsite' => 1, 'main_url' => 'http://foo.bar'), 131 | array('idsite' => 2, 'main_url' => 'https://bar.foo'), 132 | ); 133 | 134 | $mock->expects($this->any()) 135 | ->method('getAllSites') 136 | ->willReturn($sitesCollection); 137 | 138 | return $mock; 139 | } 140 | 141 | } 142 | -------------------------------------------------------------------------------- /tests/Unit/ShortcodeUrlValidatorTest.php: -------------------------------------------------------------------------------- 1 | component = new UrlValidator(); 29 | } 30 | 31 | /** 32 | * @dataProvider lengthValidationProvider 33 | */ 34 | public function testValidator($value, $expected) 35 | { 36 | $actual = $this->component->validate($value); 37 | $this->assertEquals($expected, $actual); 38 | } 39 | 40 | public function lengthValidationProvider() 41 | { 42 | return array( 43 | array('aaa', false), 44 | array('http://.', false), 45 | array('http://www', false), 46 | array('http://www.johndoe.com', true), 47 | array('http://johndoe.com', true), 48 | array('http://subdomain.johndoe.com', true), 49 | array('www.subdomain.johndoe.com', true), 50 | array('subdomain.johndoe.com', true), 51 | ); 52 | } 53 | } -------------------------------------------------------------------------------- /tests/Unit/ShortcodeValidatorTest.php: -------------------------------------------------------------------------------- 1 | component = new ShortcodeValidator(); 29 | } 30 | 31 | /** 32 | * @dataProvider lengthValidationProvider 33 | */ 34 | public function testValidator($value, $expected) 35 | { 36 | $actual = $this->component->validate($value); 37 | $this->assertEquals($expected, $actual); 38 | } 39 | 40 | public function lengthValidationProvider() 41 | { 42 | return array( 43 | array('aaa', false), 44 | array('aaaa', false), 45 | array('aaaaa', false), 46 | array('aaa!@#', false), 47 | array('aaaaaaa', false), 48 | array('aaaa ', false), 49 | array('123456', false), 50 | array('aaaaaa', true), 51 | array('abc123', true), 52 | 53 | ); 54 | } 55 | } 56 | --------------------------------------------------------------------------------