JezK

Edit File: API.php

<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */
namespace Piwik\Plugins\Annotations;

use Exception;
use Piwik\Common;
use Piwik\Date;
use Piwik\Exception\UnexpectedWebsiteFoundException;
use Piwik\Piwik;
use Piwik\Site;
/**
 * API for annotations plugin. Provides methods to create, modify, delete & query
 * annotations.
 *
 * @method static \Piwik\Plugins\Annotations\API getInstance()
 */
class API extends \Piwik\Plugin\API
{
    // do not automatically apply `Common::sanitizeInputValue` to all API parameters
    protected $autoSanitizeInputParams = \false;
    /**
     * Create a new annotation for a site.
     *
     * @param int $idSite The site ID to add the annotation to.
     * @param string $date The date the annotation is attached to.
     * @param string $note The text of the annotation (max 255 chars).
     * @param boolean $starred Whether the annotation should be starred.
     * @return array Returns an array of two elements. The first element (indexed by
     *               'annotation') is the new annotation. The second element (indexed
     *               by 'idNote' is the new note's ID).
     */
    public function add(int $idSite, string $date, string $note, bool $starred = \false) : array
    {
        $this->checkUserCanAddNotesFor($idSite);
        $this->checkSiteExists($idSite);
        $this->checkDateIsValid($date);
        $date = Date::factory($date)->toString();
        // ensure we handle today/yesterday correctly
        $annotation = ['idsite' => $idSite, 'date' => $date, 'note' => $this->filterNote($note), 'starred' => (int) $starred, 'user' => Piwik::getCurrentUserLogin()];
        $model = new \Piwik\Plugins\Annotations\Model();
        $idNote = $model->createAnnotation($annotation);
        $annotation['id'] = $idNote;
        $this->decorateAnnotation($annotation);
        return $annotation;
    }
    /**
     * Modifies an annotation for a site and returns the modified annotation
     * and its ID.
     *
     * If the current user is not allowed to modify an annotation, an exception
     * will be thrown. A user can modify a note if:
     *  - the user has admin access for the site, OR
     *  - the user has view access, is not the anonymous user and is the user that
     *    created the note
     *
     * @param int $idSite The site ID to add the annotation to.
     * @param int $idNote The ID of the note.
     * @param string|null $date The date the annotation is attached to. If null, the annotation's
     *                          date is not modified.
     * @param string|null $note The text of the annotation (max 255 chars).
     *                          If null, the annotation's text is not modified.
     * @param bool|null $starred Whether the annotation should be starred.
     *                           If null, the annotation is not starred/un-starred, so the current state won't change.
     * @return array Returns an array of two elements. The first element (indexed by
     *               'annotation') is the new annotation. The second element (indexed
     *               by 'idNote' is the new note's ID).
     * @throws UnexpectedWebsiteFoundException
     */
    public function save(int $idSite, int $idNote, ?string $date = null, ?string $note = null, ?bool $starred = null) : array
    {
        $this->checkSiteExists($idSite);
        $this->checkDateIsValid($date, $canBeNull = \true);
        if (null !== $date) {
            $date = Date::factory($date)->toString();
            // ensure we handle today/yesterday correctly
        }
        $originalAnnotation = $this->get($idSite, $idNote);
        // check if current user has the right to update the annotation
        $this->checkUserCanModifyOrDelete($originalAnnotation);
        if (isset($starred)) {
            $starred = intval($starred);
        }
        $updatedValues = array_diff_assoc(array_filter(['date' => $date, 'note' => $this->filterNote($note), 'starred' => $starred], function ($value) {
            return isset($value);
        }), $originalAnnotation);
        if (!empty($updatedValues)) {
            $model = new \Piwik\Plugins\Annotations\Model();
            $originalAnnotation = $model->updateAnnotation($idNote, $idSite, $updatedValues);
        }
        $this->decorateAnnotation($originalAnnotation);
        return $originalAnnotation;
    }
    /**
     * Removes an annotation from a site's list of annotations.
     *
     * If the current user is not allowed to delete the annotation, an exception
     * will be thrown. A user can delete a note if:
     *  - the user has admin access for the site, OR
     *  - the user has view access, is not the anonymous user and is the user that
     *    created the note
     *
     * @param int $idSite The site ID to add the annotation to.
     * @param int $idNote The ID of the note to delete.
     * @throws UnexpectedWebsiteFoundException
     */
    public function delete(int $idSite, int $idNote) : void
    {
        $this->checkSiteExists($idSite);
        $annotation = $this->get($idSite, $idNote);
        // check permissions
        $this->checkUserCanModifyOrDelete($annotation);
        $model = new \Piwik\Plugins\Annotations\Model();
        $model->deleteAnnotation($idNote, $idSite);
    }
    /**
     * Removes all annotations for a single site. Only superusers can use this method.
     *
     * @param int $idSite The ID of the site to remove annotations for.
     * @throws UnexpectedWebsiteFoundException when the required site doesn't exist
     * @throws Exception when user is not a superuser
     */
    public function deleteAll(int $idSite) : void
    {
        Piwik::checkUserHasSuperUserAccess();
        $this->checkSiteExists($idSite);
        $model = new \Piwik\Plugins\Annotations\Model();
        $model->deleteAllAnnotationsForSite($idSite);
    }
    /**
     * Returns a single annotation for one site.
     *
     * @param int $idSite The site ID the annotation is linked to.
     * @param int $idNote The ID of the annotation to get.
     * @return array The annotation. It will contain the following properties:
     *               - id: the ID of the annotation
     *               - idsite: the site the annotation is linked to
     *               - date: The date the annotation was recorded for.
     *               - note: The note text.
     *               - starred: Whether the note is starred or not.
     *               - user: The user that created the note.
     *               - canEditOrDelete: Whether the current user is permitted to edit or delete this annotation
     * @throws Exception if the $idNote does not correspond to an existing annotation
     */
    public function get(int $idSite, int $idNote) : array
    {
        Piwik::checkUserHasViewAccess($idSite);
        $this->checkSiteExists($idSite);
        $model = new \Piwik\Plugins\Annotations\Model();
        $annotation = $model->getAnnotation($idNote, $idSite);
        if (empty($annotation)) {
            throw new Exception("There is no note with id '{$idNote}' for site with id '{$idSite}'.");
        }
        $this->decorateAnnotation($annotation);
        return $annotation;
    }
    /**
     * Returns every annotation for a specific site within a specific date range.
     * The date range is specified by a date, the period type (day/week/month/year)
     * and an optional number of N periods in the past to include.
     *
     * @param string $idSite The site ID to get annotations for. Can be one ID or
     *                       a list of site IDs.
     * @param null|string $date The date of the period.
     * @param string $period The period type.
     * @param null|int $lastN Whether to include the last N number of periods in the
     *                         date range or not.
     * @return array An array that indexes arrays of annotations by site ID. ie,
     *               array(
     *                 5 => array(
     *                   array(...), // annotation #1
     *                   array(...), // annotation #2
     *                 ),
     *                 8 => array(...)
     *               )
     * @throws \Exception
     */
    public function getAll(string $idSite, ?string $date = null, string $period = 'day', ?int $lastN = null) : array
    {
        Piwik::checkUserHasViewAccess($idSite);
        $ids = array_map('intval', Site::getIdSitesFromIdSitesString($idSite));
        $model = new \Piwik\Plugins\Annotations\Model();
        $annotations = [];
        foreach ($ids as $id) {
            [$startDate, $endDate] = \Piwik\Plugins\Annotations\Annotations::getDateRangeForPeriod($date ?: \false, $period, $lastN ?? \false, $id);
            $annotations[$id] = $model->getAllAnnotationsForSiteInRange($id, $startDate ? $startDate->toString() : null, $endDate ? $endDate->toString() : null);
            for ($i = 0; $i < count($annotations[$id]); $i++) {
                $this->decorateAnnotation($annotations[$id][$i]);
            }
        }
        return $annotations;
    }
    /**
     * Returns the count of annotations for a list of periods, including the count of
     * starred annotations.
     *
     * @param string $idSite The site ID(s) to get the annotation count for.
     * @param string $date The date of the period.
     * @param string $period The period type.
     * @param int|null $lastN Whether to get counts for the last N number of periods or not.
     * @param bool $getAnnotationText
     * @return array An array mapping site IDs to arrays holding dates & the count of
     *               annotations made for those dates. eg,
     *               array(
     *                 5 => array(
     *                   array('2012-01-02', array('count' => 4, 'starred' => 2)),
     *                   array('2012-01-03', array('count' => 0, 'starred' => 0)),
     *                   array('2012-01-04', array('count' => 2, 'starred' => 0)),
     *                 ),
     *                 6 => array(
     *                   array('2012-01-02', array('count' => 1, 'starred' => 0)),
     *                   array('2012-01-03', array('count' => 4, 'starred' => 3)),
     *                   array('2012-01-04', array('count' => 2, 'starred' => 0)),
     *                 ),
     *                 ...
     *               )
     * @throws Exception when user is not a superuser
     */
    public function getAnnotationCountForDates(string $idSite, string $date, string $period, ?int $lastN = null, bool $getAnnotationText = \false) : array
    {
        Piwik::checkUserHasViewAccess($idSite);
        $siteIds = array_map('intval', Site::getIdSitesFromIdSitesString($idSite));
        if (empty($siteIds)) {
            return [];
        }
        // get start & end date for request. lastN is ignored if $period == 'range'
        [$startDate, $endDate] = \Piwik\Plugins\Annotations\Annotations::getDateRangeForPeriod($date, $period, $lastN ?? \false, $siteIds[0]);
        if (!($startDate && $endDate)) {
            return [];
        }
        if ($period == 'range') {
            $period = 'day';
        }
        // create list of dates
        $dates = [];
        for (; $startDate->getTimestamp() <= $endDate->getTimestamp(); $startDate = $startDate->addPeriod(1, $period)) {
            $dates[] = $startDate;
        }
        // we add one for the end of the last period (used in for loop below to bound annotation dates)
        $dates[] = $startDate;
        $model = new \Piwik\Plugins\Annotations\Model();
        $result = [];
        foreach ($siteIds as $siteId) {
            $result[$siteId] = [];
            for ($i = 0; $i < count($dates) - 1; $i++) {
                $date = $dates[$i];
                $nextDate = $dates[$i + 1];
                $strDate = $date->toString();
                $strNextDate = $nextDate->toString();
                [$totalCount, $starredCount] = $model->getCountAnnotationsForSiteInRange($siteId, $strDate, $strNextDate);
                $result[$siteId][] = [$strDate, ['count' => $totalCount, 'starred' => $starredCount]];
                if ($getAnnotationText && $totalCount === 1) {
                    [$annotation] = $model->getAllAnnotationsForSiteInRange($siteId, $strDate, $strNextDate, 1);
                    // 1 for the second array to add the note to
                    $result[$siteId][$i][1]['note'] = $annotation['note'];
                }
            }
        }
        return $result;
    }
    /**
     * Throws if the current user is not allowed to modify or delete an annotation.
     *
     * @param array $annotation The annotation.
     * @throws Exception if the current user is not allowed to modify/delete $annotation.
     */
    private function checkUserCanModifyOrDelete(array $annotation) : void
    {
        if (!\Piwik\Plugins\Annotations\Annotations::canUserModifyOrDelete($annotation)) {
            throw new Exception("The current user is not allowed to modify or delete notes for site #{$annotation['idSite']}");
        }
    }
    /**
     * Throws if the current user is not allowed to create annotations for a site.
     *
     * @param int $idSite The site ID.
     * @throws Exception if the current user is anonymous or does not have view access
     *                   for site w/ id=$idSite.
     */
    private static function checkUserCanAddNotesFor(int $idSite) : void
    {
        if (!Piwik::isUserHasViewAccess($idSite) || Piwik::isUserIsAnonymous()) {
            throw new Exception("The current user is not allowed to add notes for site #{$idSite}.");
        }
    }
    /**
     * Throws an exception if the given $idSite does not exist.
     *
     * @param int $idSite
     * @return void
     * @throws UnexpectedWebsiteFoundException
     */
    private function checkSiteExists(int $idSite) : void
    {
        new Site($idSite);
    }
    /**
     * Utility function, makes sure date string is valid date, and throws if
     * otherwise.
     */
    private function checkDateIsValid($date, $canBeNull = \false) : void
    {
        if ($date === null && $canBeNull) {
            return;
        }
        Date::factory($date);
    }
    private function filterNote(?string $note) : ?string
    {
        if (empty($note)) {
            return $note;
        }
        // shorten note if longer than 255 characters
        if (mb_strlen($note) > 255) {
            $note = mb_substr($note, 0, 254) . '…';
        }
        return $note;
    }
    private function decorateAnnotation(array &$annotation) : void
    {
        $annotation['date'] = substr($annotation['date'], 0, 10);
        $annotation['note'] = Common::sanitizeInputValue($annotation['note']);
        $annotation['canEditOrDelete'] = \Piwik\Plugins\Annotations\Annotations::canUserModifyOrDelete($annotation);
        $annotation['idNote'] = $annotation['id'];
        // for API backward compatibility
    }
}