CRM/Dashlet/Page/GettingStarted.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Main page for getting started dashlet
  38  */
  39 class CRM_Dashlet_Page_GettingStarted extends CRM_Core_Page {
  40
  41   const CHECK_TIMEOUT = 5;
  42   const CACHE_DAYS = 5;
  43   const GETTING_STARTED_URL = 'https://alert.civicrm.org/welcome?prot=1&ver={ver}&uf={uf}&sid={sid}&lang={lang}&co={co}';
  44
  45   /**
  46    * Define tokens available for getting started
  47    * @var array
  48    */
  49   public static $_tokens = [
  50     'crmurl' => [
  51       'configbackend' => 'civicrm/admin/configtask',
  52     ],
  53   ];
  54
  55   /**
  56    * Get the final, usable URL string (after interpolating any variables)
  57    *
  58    * @return FALSE|string
  59    */
  60   public function gettingStartedUrl() {
  61     // Note: We use "*default*" as the default (rather than self::GETTING_STARTED_URL) so that future
  62     // developers can change GETTING_STARTED_URL without needing to update {civicrm_setting}.
  63     $url = Civi::settings()->get('gettingStartedUrl');
  64     if ($url === '*default*') {
  65       $url = self::GETTING_STARTED_URL;
  66     }
  67     return CRM_Utils_System::evalUrl($url);
  68   }
  69
  70   /**
  71    * List gettingStarted page as dashlet.
  72    */
  73   public function run() {
  74     $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this, FALSE, 'dashlet');
  75
  76     // Assign smarty variables.
  77     $this->assign('context', $context);
  78     $this->assign('gettingStarted', $this->_gettingStarted());
  79
  80     // Use smarty to generate page.
  81     return parent::run();
  82   }
  83
  84   /**
  85    * Load gettingStarted page from cache.
  86    * Refresh cache if expired
  87    *
  88    * @return array
  89    */
  90   private function _gettingStarted() {
  91     $value = Civi::cache('community_messages')->get('dashboard_gettingStarted');
  92
  93     if (!$value) {
  94       $value = $this->_getHtml($this->gettingStartedUrl());
  95
  96       if ($value) {
  97         Civi::cache('community_messages')->set('dashboard_gettingStarted', $value, (60 * 60 * 24 * self::CACHE_DAYS));
  98       }
  99     }
 100
 101     return $value;
 102   }
 103
 104   /**
 105    * Get html.
 106    *
 107    * @param $url
 108    *
 109    * @return array|NULL
 110    *   array of gettingStarted items; or NULL if not available
 111    */
 112   public function _getHtml($url) {
 113     $httpClient = new CRM_Utils_HttpClient(self::CHECK_TIMEOUT);
 114     list ($status, $html) = $httpClient->get($url);
 115
 116     if ($status !== CRM_Utils_HttpClient::STATUS_OK) {
 117       return NULL;
 118     }
 119
 120     $tokensList = CRM_Utils_Token::getTokens($html);
 121     $this->replaceLinkToken($tokensList, $html);
 122     return $html;
 123   }
 124
 125   /**
 126    * @param array $tokensList
 127    * @param string $str
 128    *
 129    */
 130   public function replaceLinkToken($tokensList, &$str) {
 131     foreach ($tokensList as $categories => $tokens) {
 132       foreach ($tokens as $token) {
 133         $value = '';
 134         if (!empty(self::$_tokens[$categories][$token])) {
 135           $value = self::$_tokens[$categories][$token];
 136           if ($categories == 'crmurl') {
 137             $value = CRM_Utils_System::url($value, "reset=1");
 138           }
 139         }
 140         CRM_Utils_Token::token_replace($categories, $token, $value, $str);
 141       }
 142     }
 143   }
 144
 145 }