pkp/pkp-lib#9296 Sandbox settings

nibou230 · Feb 15, 2024 · 95cd926 · 95cd926
1 parent ce77f23
commit 95cd926
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 5 deletions.
diff --git a/config.TEMPLATE.inc.php b/config.TEMPLATE.inc.php
@@ -134,6 +134,10 @@
 ; 0, unvalidated accounts will never be removed. Use this setting to automatically remove bot registrations.
 user_validation_period = 28
 
+; Turn sandbox mode to On in order to prevent the software from interacting with outside systems.
+; Use this for development or testing purposes.
+sandbox = Off
+
 
 ;;;;;;;;;;;;;;;;;;;;;
 ; Database Settings ;

diff --git a/plugins/generic/datacite/DataciteExportPlugin.php b/plugins/generic/datacite/DataciteExportPlugin.php
@@ -241,6 +241,12 @@ public function exportAsDownload(Context $context, array $objects, ?bool $noVali
      */
     public function depositXML($object, $context, $filename)
     {
+        // Application is set to sandbox mode and will not run the features of plugin
+        if (Config::getVar('general', 'sandbox', false)) {
+            error_log('Application is set to sandbox mode and datacite will not do any deposition');
+            return false;
+        }
+
         $request = Application::get()->getRequest();
         // Get the DOI and the URL for the object.
         $doi = $object->getStoredPubId('doi');

diff --git a/plugins/paymethod/paypal/PaypalPaymentForm.php b/plugins/paymethod/paypal/PaypalPaymentForm.php
@@ -19,6 +19,7 @@
 use APP\core\Request;
 use APP\template\TemplateManager;
 use Omnipay\PayPal\Message\RestAuthorizeResponse;
+use PKP\config\Config;
 use PKP\form\Form;
 use PKP\payment\QueuedPayment;
 
@@ -49,6 +50,15 @@ public function __construct($paypalPaymentPlugin, $queuedPayment)
      */
     public function display($request = null, $template = null)
     {
+        // Application is set to sandbox mode and will not run the features of plugin
+        if (Config::getVar('general', 'sandbox', false)) {
+            error_log('Application is set to sandbox mode and no payment will be done via paypal');
+            TemplateManager::getManager($request)
+                ->assign('message', 'common.sandbox')
+                ->display('frontend/pages/message.tpl');
+            return;
+        }
+
         try {
             $journal = $request->getJournal();
             $paymentManager = Application::getPaymentManager($journal);

diff --git a/plugins/paymethod/paypal/PaypalPaymentPlugin.php b/plugins/paymethod/paypal/PaypalPaymentPlugin.php
@@ -21,6 +21,7 @@
 use APP\template\TemplateManager;
 use Illuminate\Support\Collection;
 use Omnipay\Omnipay;
+use PKP\config\Config;
 use PKP\db\DAORegistry;
 use PKP\plugins\Hook;
 use PKP\plugins\PaymethodPlugin;
@@ -60,12 +61,13 @@ public function getDescription()
      */
     public function register($category, $path, $mainContextId = null)
     {
-        if (parent::register($category, $path, $mainContextId)) {
-            $this->addLocaleData();
-            Hook::add('Form::config::before', $this->addSettings(...));
-            return true;
+        if (!parent::register($category, $path, $mainContextId)) {
+            return false;
         }
-        return false;
+
+        $this->addLocaleData();
+        Hook::add('Form::config::before', $this->addSettings(...));
+        return true;
     }
 
     /**
@@ -175,6 +177,12 @@ public function isConfigured($context)
      */
     public function handle($args, $request)
     {
+        // Application is set to sandbox mode and will not run the features of plugin
+        if (Config::getVar('general', 'sandbox', false)) {
+            error_log('Application is set to sandbox mode and no payment will be done via paypal');
+            return;
+        }
+
         $journal = $request->getJournal();
         $queuedPaymentDao = DAORegistry::getDAO('QueuedPaymentDAO'); /** @var \PKP\payment\QueuedPaymentDAO $queuedPaymentDao */
         try {