Add a Scheduled Tasks Infrastructure to Joomla

.drone.yml

@@ -205,6 +205,25 @@ steps:
       status:
         - failure
 
+  - name: analysis4x
+    image: rips/rips-cli:3.2.2
+    failure: ignore
+    depends_on: [ api-tests ]
+    when:
+      repo:
+        - joomla/joomla-cms
+      branch:
+        - 4.0-dev
+    commands:
+      - export RIPS_BASE_URI='https://api.rips.joomla.org'
+      - rips-cli rips:list --table=scans --parameter filter='{"__and":[{"__lessThan":{"percent":100}}]}'
+      - rips-cli rips:scan:start --progress --application=2 --threshold=0 --path=$(pwd) --remove-code --remove-upload --tag=$DRONE_REPO_NAMESPACE-$DRONE_BRANCH || { echo "Please contact the security team at [email protected]"; exit 1; }
+    environment:
+      RIPS_EMAIL:
+        from_secret: RIPS_EMAIL
+      RIPS_PASSWORD:
+        from_secret: RIPS_PASSWORD
+
 branches:
   exclude: [ l10n_* ]
 
@@ -275,6 +294,6 @@ steps:
 
 ---
 kind: signature
-hmac: bd749550476cef0ec9258524e7f158b25dd3adf55758bb1c24874a185db1b40a
+hmac: ec1b070b49dd11b007d258a698c5b0d0217e5d90dabf1b9cb606e4fb4a28d1a0
 
 ...

plugins/system/tasknotification/language/en-GB/plg_system_tasknotification.ini

@@ -0,0 +1,16 @@
+PLG_SYSTEM_TASK_NOTIFICATION="System - Task Notification"
+PLG_SYSTEM_TASK_NOTIFICATION_FAILURE_MAIL_BODY="Hello,\n\n\nPlanned execution of Scheduled Task#{TASK_ID}, {TASK_TITLE}, has failed with exit code {EXIT_CODE} at {EXEC_DATE_TIME}.\n\nPlease visit the Joomla! backend for more information.\n\n{TASK_OUTPUT}"
+PLG_SYSTEM_TASK_NOTIFICATION_FAILURE_MAIL_SUBJECT="Task Failure"
+PLG_SYSTEM_TASK_NOTIFICATION_FATAL_MAIL_BODY="Hello,\n\nPlanned execution of Scheduler Task#{TASK_ID}, {TASK_TITLE}, recovered from a fatal failure.\n\nThis could mean that the task execution exhausted the system resources or the restrictions from the PHP INI.\n\nPlease visit the Joomla! backend for more information."
+PLG_SYSTEM_TASK_NOTIFICATION_FATAL_MAIL_SUBJECT="Task Recover from Fatal Failure"
+PLG_SYSTEM_TASK_NOTIFICATION_LABEL_FAILURE_MAIL_TOGGLE="Notifications on Task Failure"
+PLG_SYSTEM_TASK_NOTIFICATION_LABEL_FATAL_FAILURE_MAIL_TOGGLE="Notifications on Fatal Failures/Crashes (Recommended)"
+PLG_SYSTEM_TASK_NOTIFICATION_LABEL_ORPHANED_TASK_MAIL_TOGGLE="Notifications on Orphaned Tasks (Recommended)"
+PLG_SYSTEM_TASK_NOTIFICATION_LABEL_SUCCESS_MAIL_TOGGLE="Notifications on Task Success"
+PLG_SYSTEM_TASK_NOTIFICATION_NO_MAIL_SENT="Could not send task notification to any user. This either means that mailer is not set up properly or no user with system emails enabled, com_scheduler `core.manage` privilege exists."
+PLG_SYSTEM_TASK_NOTIFICATION_ORPHAN_MAIL_BODY="Hello,\n\nScheduled Task#{TASK_ID}, {TASK_TITLE}, has been orphaned. This likely means that the provider plugin was removed or disabled from your Joomla! installation.\n\nPlease visit the Joomla! backend to investigate."
+PLG_SYSTEM_TASK_NOTIFICATION_ORPHAN_MAIL_SUBJECT="New Orphaned Task"
+PLG_SYSTEM_TASK_NOTIFICATION_SUCCESS_MAIL_BODY="Hello,\n\nScheduled Task#{TASK_ID}, {TASK_TITLE}, has been successfully executed at {EXEC_DATE_TIME}.\n\n{TASK_OUTPUT}"
+PLG_SYSTEM_TASK_NOTIFICATION_SUCCESS_MAIL_SUBJECT="Task Successful"
+PLG_SYSTEM_TASK_NOTIFICATION_USER_FETCH_FAIL="Failed to fetch users to send notifications to."
+PLG_SYSTEM_TASK_NOTIFICATION_XML_DESCRIPTION="Responsible for email notifications for execution of Scheduled tasks."

plugins/system/tasknotification/language/en-GB/plg_system_tasknotification.sys.ini

@@ -0,0 +1,2 @@
+PLG_SYSTEM_TASK_NOTIFICATION="System - Task Notification"
+PLG_SYSTEM_TASK_NOTIFICATION_XML_DESCRIPTION="Responsible for email notifications for execution of Scheduled tasks."

plugins/task/checkfiles/language/en-GB/plg_task_checkfiles.ini

@@ -0,0 +1,16 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_TASK_CHECK_FILES="Task - Check Files"
+PLG_TASK_CHECK_FILES_LABEL_DIMENSION_LIMIT="Limit"
+PLG_TASK_CHECK_FILES_LABEL_DIRECTORY="Directory"
+PLG_TASK_CHECK_FILES_LABEL_IMAGE_DIMENSION="Dimension"
+PLG_TASK_CHECK_FILES_LOG_IMAGE_PATH_NA="Image path does exist!"
+PLG_TASK_CHECK_FILES_LOG_IMAGE_SAVE_FAIL="Failed to save image file"
+PLG_TASK_CHECK_FILES_LOG_RESIZE_FAIL="Failed to resize image due to an error in plugin logic..."
+PLG_TASK_CHECK_FILES_LOG_RESIZING_IMAGE="Found image of size %1$sx%2$s px; resizing to %3$sx%4$s px. File: %5$s"
+PLG_TASK_CHECK_FILES_TASK_IMAGE_SIZE_DESC="Check images, resize if larger than allowed."
+PLG_TASK_CHECK_FILES_TASK_IMAGE_SIZE_TITLE="Image Size Check!"
+PLG_TASK_CHECK_FILES_XML_DESCRIPTION="Offers task routines for checking for oversized files, and related actions if possible."

plugins/task/checkfiles/language/en-GB/plg_task_checkfiles.sys.ini

@@ -0,0 +1,7 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_TASK_CHECK_FILES="Task - Check Files"
+PLG_TASK_CHECK_FILES_XML_DESCRIPTION="Offers task routines for checking for oversized files, and related actions if possible."

plugins/task/demotasks/language/en-GB/plg_task_demotasks.ini

@@ -0,0 +1,15 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_TASK_DEMO_TASKS="Task - Demo Tasks!"
+PLG_TASK_DEMO_TASKS_SLEEP_TIMEOUT_LABEL="Sleep Timeout (seconds)"
+PLG_TASK_DEMO_TASKS_STRESS_MEMORY_DESC="What happens to a task when the PHP memory limit is exhausted?"
+PLG_TASK_DEMO_TASKS_STRESS_MEMORY_OVERRIDE_DESC="What happens to a task when the system memory is exhausted?"
+PLG_TASK_DEMO_TASKS_STRESS_MEMORY_OVERRIDE_TITLE="Stress Memory, Override Limit"
+PLG_TASK_DEMO_TASKS_STRESS_MEMORY_TITLE="Stress Memory"
+PLG_TASK_DEMO_TASKS_TASK_SLEEP_DESC="Sleep, do nothing for x seconds."
+PLG_TASK_DEMO_TASKS_TASK_SLEEP_ROUTINE_END_LOG_MESSAGE="TestTask1 return code is: %1$d. Processing Time: %2$.2f seconds"
+PLG_TASK_DEMO_TASKS_TASK_SLEEP_TITLE="Demo Task - Sleep"
+PLG_TASK_DEMO_TASKS_XML_DESCRIPTION="This is a demo plugin for the development of Joomla! Scheduled Tasks."

plugins/task/demotasks/language/en-GB/plg_task_demotasks.sys.ini

@@ -0,0 +1,7 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_TASK_DEMO_TASKS="Task - Demo Tasks!"
+PLG_TASK_DEMO_TASKS_XML_DESCRIPTION="This is a demo plugin for the development of Joomla! Scheduled Tasks."

plugins/task/requests/language/en-GB/plg_task_requests.ini

@@ -0,0 +1,20 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_TASK_REQUESTS="Task - Requests"
+PLG_TASK_REQUESTS_BEARER="Bearer"
+PLG_TASK_REQUESTS_JOOMLA_TOKEN="X-Joomla-Token"
+PLG_TASK_REQUESTS_LABEL_AUTH="Authorization"
+PLG_TASK_REQUESTS_LABEL_AUTH_HEADER="Authorization Header"
+PLG_TASK_REQUESTS_LABEL_AUTH_KEY="Authorization Key"
+PLG_TASK_REQUESTS_LABEL_REQUEST_TIMEOUT="Request Timeout"
+PLG_TASK_REQUESTS_LABEL_REQUEST_URL="Request URL"
+PLG_TASK_REQUESTS_TASK_GET_REQUEST_DESC="Make GET requests to a server. Supports a custom timeout and authorization headers."
+PLG_TASK_REQUESTS_TASK_GET_REQUEST_LOG_RESPONSE="Request response code was: %1$d"
+PLG_TASK_REQUESTS_TASK_GET_REQUEST_LOG_TIMEOUT="GET request failed or timed out."
+PLG_TASK_REQUESTS_TASK_GET_REQUEST_LOG_UNWRITEABLE_OUTPUT="Unable write output file!"
+PLG_TASK_REQUESTS_TASK_GET_REQUEST_ROUTINE_END_LOG_MESSAGE="GET return code is: %1$d. Processing Time: %2$.2f seconds"
+PLG_TASK_REQUESTS_TASK_GET_REQUEST_TITLE="GET Request"
+PLG_TASK_REQUESTS_XML_DESCRIPTION="Job plugin to make GET requests to a server."

plugins/task/requests/language/en-GB/plg_task_requests.sys.ini

@@ -0,0 +1,7 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_TASK_REQUESTS="Task - Requests"
+PLG_TASK_REQUESTS_XML_DESCRIPTION="Job plugin to make GET requests to a server."

plugins/task/sitestatus/language/en-GB/plg_task_sitestatus.ini

@@ -0,0 +1,20 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_TASK_SITE_STATUS="Task - Site Status"
+PLG_TASK_SITE_STATUS_DESC="Toggles the site's status on each run."
+PLG_TASK_SITE_STATUS_ERROR_CONFIGURATION_PHP_NOTUNWRITABLE="Could not make configuration.php un-writable."
+PLG_TASK_SITE_STATUS_ERROR_CONFIGURATION_PHP_NOTWRITABLE="Could not make configuration.php writable."
+PLG_TASK_SITE_STATUS_ERROR_WRITE_FAILED="Could not write to the configuration file!"
+PLG_TASK_SITE_STATUS_ROUTINE_END_LOG_MESSAGE="ToggleOffline return code is: %1$d. Processing Time: %2$.2f seconds."
+PLG_TASK_SITE_STATUS_TASK_LOG_SITE_STATUS="Site was %1$s, is now %2$s."
+PLG_TASK_SITE_STATUS_SET_OFFLINE_DESC="Sets site offline to online on each run."
+PLG_TASK_SITE_STATUS_SET_OFFLINE_ROUTINE_END_LOG_MESSAGE="SetOffline return code is: %1$d. Processing Time: %2$.2f seconds."
+PLG_TASK_SITE_STATUS_SET_OFFLINE_TITLE="Set Site Offline."
+PLG_TASK_SITE_STATUS_SET_ONLINE_DESC="Sets site status to online on each run."
+PLG_TASK_SITE_STATUS_SET_ONLINE_ROUTINE_END_LOG_MESSAGE="SetOnline return code is: %1$d. Processing Time: %2$.2f seconds."
+PLG_TASK_SITE_STATUS_SET_ONLINE_TITLE="Set Site Online."
+PLG_TASK_SITE_STATUS_TITLE="Toggle Offline."
+PLG_TASK_SITE_STATUS_XML_DESCRIPTION="Offers task routines to change the site's offline status."

plugins/task/sitestatus/language/en-GB/plg_task_sitestatus.sys.ini

@@ -0,0 +1,7 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_TASK_SITE_STATUS="Task - Site Status"
+PLG_TASK_SITE_STATUS_XML_DESCRIPTION="Offers task routines to change the site's offline status."