summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorJakob Sack <mail@jakobsack.de>2012-08-10 13:00:51 +0200
committerJakob Sack <mail@jakobsack.de>2012-08-10 13:00:51 +0200
commit81b997b56ef130111b527e5b40f5d3348f30aecc (patch)
tree645feaefbe5ef6d00d725259f284e329f3121feb /lib
parent82b10954e714135aac332c4e349124731841aa90 (diff)
parent9ad31e5f81ad5ec899101a67451843dd8f080340 (diff)
downloadnextcloud-server-81b997b56ef130111b527e5b40f5d3348f30aecc.tar.gz
nextcloud-server-81b997b56ef130111b527e5b40f5d3348f30aecc.zip
Merge branch 'backgroundjobs'
Diffstat (limited to 'lib')
-rw-r--r--lib/backgroundjob/queuedtask.php104
-rw-r--r--lib/backgroundjob/regulartask.php52
-rw-r--r--lib/backgroundjob/worker.php118
-rw-r--r--lib/base.php6
-rw-r--r--lib/public/backgroundjob.php117
5 files changed, 397 insertions, 0 deletions
diff --git a/lib/backgroundjob/queuedtask.php b/lib/backgroundjob/queuedtask.php
new file mode 100644
index 00000000000..da5d4ddc694
--- /dev/null
+++ b/lib/backgroundjob/queuedtask.php
@@ -0,0 +1,104 @@
+<?php
+/**
+* ownCloud
+*
+* @author Jakob Sack
+* @copyright 2012 Jakob Sack owncloud@jakobsack.de
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+*
+* You should have received a copy of the GNU Affero General Public
+* License along with this library. If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/**
+ * This class manages our queued tasks.
+ */
+class OC_BackgroundJob_QueuedTask{
+ /**
+ * @brief Gets one queued task
+ * @param $id ID of the task
+ * @return associative array
+ */
+ public static function find( $id ){
+ $stmt = OC_DB::prepare( 'SELECT * FROM *PREFIX*queuedtasks WHERE id = ?' );
+ $result = $stmt->execute(array($id));
+ return $result->fetchRow();
+ }
+
+ /**
+ * @brief Gets all queued tasks
+ * @return array with associative arrays
+ */
+ public static function all(){
+ // Array for objects
+ $return = array();
+
+ // Get Data
+ $stmt = OC_DB::prepare( 'SELECT * FROM *PREFIX*queuedtasks' );
+ $result = $stmt->execute(array());
+ while( $row = $result->fetchRow()){
+ $return[] = $row;
+ }
+
+ return $return;
+ }
+
+ /**
+ * @brief Gets all queued tasks of a specific app
+ * @param $app app name
+ * @return array with associative arrays
+ */
+ public static function whereAppIs( $app ){
+ // Array for objects
+ $return = array();
+
+ // Get Data
+ $stmt = OC_DB::prepare( 'SELECT * FROM *PREFIX*queuedtasks WHERE app = ?' );
+ $result = $stmt->execute(array($app));
+ while( $row = $result->fetchRow()){
+ $return[] = $row;
+ }
+
+ // Und weg damit
+ return $return;
+ }
+
+ /**
+ * @brief queues a task
+ * @param $app app name
+ * @param $klass class name
+ * @param $method method name
+ * @param $parameters all useful data as text
+ * @return id of task
+ */
+ public static function add( $task, $klass, $method, $parameters ){
+ $stmt = OC_DB::prepare( 'INSERT INTO *PREFIX*queuedtasks (app, klass, method, parameters) VALUES(?,?,?,?)' );
+ $result = $stmt->execute(array($app, $klass, $method, $parameters, time));
+
+ return OC_DB::insertid();
+ }
+
+ /**
+ * @brief deletes a queued task
+ * @param $id id of task
+ * @return true/false
+ *
+ * Deletes a report
+ */
+ public static function delete( $id ){
+ $stmt = OC_DB::prepare( 'DELETE FROM *PREFIX*queuedtasks WHERE id = ?' );
+ $result = $stmt->execute(array($id));
+
+ return true;
+ }
+}
diff --git a/lib/backgroundjob/regulartask.php b/lib/backgroundjob/regulartask.php
new file mode 100644
index 00000000000..53bd4eb5e9b
--- /dev/null
+++ b/lib/backgroundjob/regulartask.php
@@ -0,0 +1,52 @@
+<?php
+/**
+* ownCloud
+*
+* @author Jakob Sack
+* @copyright 2012 Jakob Sack owncloud@jakobsack.de
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+*
+* You should have received a copy of the GNU Affero General Public
+* License along with this library. If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/**
+ * This class manages the regular tasks.
+ */
+class OC_BackgroundJob_RegularTask{
+ static private $registered = array();
+
+ /**
+ * @brief creates a regular task
+ * @param $klass class name
+ * @param $method method name
+ * @return true
+ */
+ static public function register( $klass, $method ){
+ // Create the data structure
+ self::$registered["$klass-$method"] = array( $klass, $method );
+
+ // No chance for failure ;-)
+ return true;
+ }
+
+ /**
+ * @brief gets all regular tasks
+ * @return associative array
+ *
+ * key is string "$klass-$method", value is array( $klass, $method )
+ */
+ static public function all(){
+ return self::$registered;
+ }
+}
diff --git a/lib/backgroundjob/worker.php b/lib/backgroundjob/worker.php
new file mode 100644
index 00000000000..b4f0429b319
--- /dev/null
+++ b/lib/backgroundjob/worker.php
@@ -0,0 +1,118 @@
+<?php
+/**
+* ownCloud
+*
+* @author Jakob Sack
+* @copyright 2012 Jakob Sack owncloud@jakobsack.de
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+*
+* You should have received a copy of the GNU Affero General Public
+* License along with this library. If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/**
+ * This class does the dirty work.
+ *
+ * TODO: locking in doAllSteps
+ */
+class OC_BackgroundJob_Worker{
+ /**
+ * @brief executes all tasks
+ * @return boolean
+ *
+ * This method executes all regular tasks and then all queued tasks.
+ * This method should be called by cli scripts that do not let the user
+ * wait.
+ */
+ public static function doAllSteps(){
+ // Do our regular work
+ $lasttask = OC_Appconfig::getValue( 'core', 'backgroundjobs_task', '' );
+
+ $regular_tasks = OC_BackgroundJob_RegularTask::all();
+ ksort( $regular_tasks );
+ foreach( $regular_tasks as $key => $value ){
+ if( strcmp( $key, $lasttask ) > 0 ){
+ // Set "restart here" config value
+ OC_Appconfig::setValue( 'core', 'backgroundjobs_task', $key );
+ call_user_func( $value );
+ }
+ }
+ // Reset "start here" config value
+ OC_Appconfig::setValue( 'core', 'backgroundjobs_task', '' );
+
+ // Do our queued tasks
+ $queued_tasks = OC_BackgroundJob_QueuedTask::all();
+ foreach( $queued_tasks as $task ){
+ OC_BackgroundJob_QueuedTask::delete( $task['id'] );
+ call_user_func( array( $task['klass'], $task['method'] ), $task['parameters'] );
+ }
+
+ return true;
+ }
+
+ /**
+ * @brief does a single task
+ * @return boolean
+ *
+ * This method executes one task. It saves the last state and continues
+ * with the next step. This method should be used by webcron and ajax
+ * services.
+ */
+ public static function doNextStep(){
+ $laststep = OC_Appconfig::getValue( 'core', 'backgroundjobs_step', 'regular_tasks' );
+
+ if( $laststep == 'regular_tasks' ){
+ // get last app
+ $lasttask = OC_Appconfig::getValue( 'core', 'backgroundjobs_task', '' );
+
+ // What's the next step?
+ $regular_tasks = OC_BackgroundJob_RegularTask::all();
+ ksort( $regular_tasks );
+ $done = false;
+
+ // search for next background job
+ foreach( $regular_tasks as $key => $value ){
+ if( strcmp( $key, $lasttask ) > 0 ){
+ OC_Appconfig::setValue( 'core', 'backgroundjobs_task', $key );
+ $done = true;
+ call_user_func( $value );
+ break;
+ }
+ }
+
+ if( $done == false ){
+ // Next time load queued tasks
+ OC_Appconfig::setValue( 'core', 'backgroundjobs_step', 'queued_tasks' );
+ }
+ }
+ else{
+ $tasks = OC_BackgroundJob_QueuedTask::all();
+ if( count( $tasks )){
+ $task = $tasks[0];
+ // delete job before we execute it. This prevents endless loops
+ // of failing jobs.
+ OC_BackgroundJob_QueuedTask::delete($task['id']);
+
+ // execute job
+ call_user_func( array( $task['klass'], $task['method'] ), $task['parameters'] );
+ }
+ else{
+ // Next time load queued tasks
+ OC_Appconfig::setValue( 'core', 'backgroundjobs_step', 'regular_tasks' );
+ OC_Appconfig::setValue( 'core', 'backgroundjobs_task', '' );
+ }
+ }
+
+ return true;
+ }
+}
diff --git a/lib/base.php b/lib/base.php
index c4127c73f26..dae62a029c8 100644
--- a/lib/base.php
+++ b/lib/base.php
@@ -241,11 +241,17 @@ class OC{
OC_Util::addScript( "jquery.infieldlabel.min" );
OC_Util::addScript( "jquery-tipsy" );
OC_Util::addScript( "oc-dialogs" );
+ OC_Util::addScript( "backgroundjobs" );
OC_Util::addScript( "js" );
OC_Util::addScript( "eventsource" );
OC_Util::addScript( "config" );
//OC_Util::addScript( "multiselect" );
OC_Util::addScript('search','result');
+
+ if( OC_Appconfig::getValue( 'core', 'backgroundjobs_mode', 'ajax' ) == 'ajax' ){
+ OC_Util::addScript( 'backgroundjobs' );
+ }
+
OC_Util::addStyle( "styles" );
OC_Util::addStyle( "multiselect" );
OC_Util::addStyle( "jquery-ui-1.8.16.custom" );
diff --git a/lib/public/backgroundjob.php b/lib/public/backgroundjob.php
new file mode 100644
index 00000000000..72f4557eb1a
--- /dev/null
+++ b/lib/public/backgroundjob.php
@@ -0,0 +1,117 @@
+<?php
+/**
+* ownCloud
+*
+* @author Jakob Sack
+* @copyright 2012 Jakob Sack owncloud@jakobsack.de
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+*
+* You should have received a copy of the GNU Affero General Public
+* License along with this library. If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/**
+ * Public interface of ownCloud forbackground jobs.
+ */
+
+// use OCP namespace for all classes that are considered public.
+// This means that they should be used by apps instead of the internal ownCloud classes
+namespace OCP;
+
+/**
+ * This class provides functions to manage backgroundjobs in ownCloud
+ *
+ * There are two kind of background jobs in ownCloud: regular tasks and
+ * queued tasks.
+ *
+ * Regular tasks have to be registered in appinfo.php and
+ * will run on a regular base. Fetching news could be a task that should run
+ * frequently.
+ *
+ * Queued tasks have to be registered each time you want to execute them.
+ * An example of the queued task would be the creation of the thumbnail. As
+ * soon as the user uploads a picture the gallery app registers the queued
+ * task "create thumbnail" and saves the path in the parameter instead of doing
+ * the work right away. This makes the app more responsive. As soon as the task
+ * is done it will be deleted from the list.
+ */
+class BackgroundJob {
+ /**
+ * @brief creates a regular task
+ * @param $klass class name
+ * @param $method method name
+ * @return true
+ */
+ public static function addRegularTask( $klass, $method ){
+ return \OC_BackgroundJob_RegularTask::register( $klass, $method );
+ }
+
+ /**
+ * @brief gets all regular tasks
+ * @return associative array
+ *
+ * key is string "$klass-$method", value is array( $klass, $method )
+ */
+ static public function allRegularTasks(){
+ return \OC_BackgroundJob_RegularTask::all();
+ }
+
+ /**
+ * @brief Gets one queued task
+ * @param $id ID of the task
+ * @return associative array
+ */
+ public static function findQueuedTask( $id ){
+ return \OC_BackgroundJob_QueuedTask::find( $id );
+ }
+
+ /**
+ * @brief Gets all queued tasks
+ * @return array with associative arrays
+ */
+ public static function allQueuedTasks(){
+ return \OC_BackgroundJob_QueuedTask::all();
+ }
+
+ /**
+ * @brief Gets all queued tasks of a specific app
+ * @param $app app name
+ * @return array with associative arrays
+ */
+ public static function queuedTaskWhereAppIs( $app ){
+ return \OC_BackgroundJob_QueuedTask::whereAppIs( $app );
+ }
+
+ /**
+ * @brief queues a task
+ * @param $app app name
+ * @param $klass class name
+ * @param $method method name
+ * @param $parameters all useful data as text
+ * @return id of task
+ */
+ public static function addQueuedTask( $task, $klass, $method, $parameters ){
+ return \OC_BackgroundJob_QueuedTask::add( $task, $klass, $method, $parameters );
+ }
+
+ /**
+ * @brief deletes a queued task
+ * @param $id id of task
+ * @return true/false
+ *
+ * Deletes a report
+ */
+ public static function deleteQueuedTask( $id ){
+ return \OC_BackgroundJob_QueuedTask::delete( $id );
+ }
+}