first commit

lib/pkp/classes/security/authorization/internal/SubmissionFileBaseAccessPolicy.php

@@ -0,0 +1,99 @@
+<?php
+/**
+ * @file classes/security/authorization/internal/SubmissionFileBaseAccessPolicy.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2000-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class SubmissionFileBaseAccessPolicy
+ *
+ * @ingroup security_authorization_internal
+ *
+ * @brief Abstract class for submission file access policies.
+ *
+ */
+
+namespace PKP\security\authorization\internal;
+
+use APP\facades\Repo;
+use PKP\core\PKPRequest;
+use PKP\security\authorization\AuthorizationPolicy;
+use PKP\submissionFile\SubmissionFile;
+
+class SubmissionFileBaseAccessPolicy extends AuthorizationPolicy
+{
+    /** @var PKPRequest */
+    public $_request;
+
+    /** @var int Submission file id */
+    public $_submissionFileId;
+
+    /**
+     * Constructor
+     *
+     * @param PKPRequest $request
+     * @param int $submissionFileId If passed, this policy will try to
+     * get the submission file from this data.
+     */
+    public function __construct($request, $submissionFileId = null)
+    {
+        parent::__construct('user.authorization.submissionFile');
+        $this->_request = $request;
+        $this->_submissionFileId = $submissionFileId;
+    }
+
+
+    //
+    // Private methods
+    //
+    /**
+     * Get a cache of submission files. Used because many policy subclasses
+     * may be combined to fetch a single submission file.
+     *
+     * @return array
+     */
+    public function &_getCache()
+    {
+        static $cache = [];
+        return $cache;
+    }
+
+
+    //
+    // Protected methods
+    //
+    /**
+     * Get the requested submission file.
+     *
+     * @param PKPRequest $request
+     *
+     * @return SubmissionFile
+     */
+    public function getSubmissionFile($request)
+    {
+        // Get the identifying info from the request
+        if (is_null($this->_submissionFileId)) {
+            $this->_submissionFileId = (int) $request->getUserVar('submissionFileId');
+            assert($this->_submissionFileId > 0);
+        }
+
+        // Fetch the object, caching if possible
+        $cache = & $this->_getCache();
+        return $cache[$this->_submissionFileId] ??= Repo::submissionFile()->get($this->_submissionFileId);
+    }
+
+    /**
+     * Get the current request object.
+     *
+     * @return PKPRequest
+     */
+    public function getRequest()
+    {
+        return $this->_request;
+    }
+}
+
+if (!PKP_STRICT_MODE) {
+    class_alias('\PKP\security\authorization\internal\SubmissionFileBaseAccessPolicy', '\SubmissionFileBaseAccessPolicy');
+}