Merge branch 'backgroundjobs'

core/js/backgroundjobs.js

@@ -0,0 +1,25 @@
+/**
+* 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/>.
+*
+*/
+
+// start worker once page has loaded
+$(document).ready(function(){
+	$.get( OC.webroot+'/cron.php' );
+});

cron.php

@@ -0,0 +1,72 @@
+<?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/>.
+*
+*/
+
+// Unfortunately we need this class for shutdown function
+class my_temporary_cron_class {
+	public static $sent = false;
+}
+
+function handleUnexpectedShutdown() {
+	if( !my_temporary_cron_class::$sent ){
+		if( OC::$CLI ){
+			echo 'Unexpected error!'.PHP_EOL;
+		}
+		else{
+			OC_JSON::error( array( 'data' => array( 'message' => 'Unexpected error!')));
+		}
+	}
+}
+
+$RUNTIME_NOSETUPFS = true;
+require_once('lib/base.php');
+
+// Handle unexpected errors
+register_shutdown_function('handleUnexpectedShutdown');
+
+$appmode = OC_Appconfig::getValue( 'core', 'backgroundjobs_mode', 'ajax' );
+if( OC::$CLI ){
+	if( $appmode != 'cron' ){
+		OC_Appconfig::setValue( 'core', 'backgroundjobs_mode', 'cron' );
+	}
+
+	// check if backgroundjobs is still running
+	$pid = OC_Appconfig::getValue( 'core', 'backgroundjobs_pid', false );
+	if( $pid !== false ){
+		// FIXME: check if $pid is still alive (*nix/mswin). if so then exit
+	}
+	// save pid
+	OC_Appconfig::setValue( 'core', 'backgroundjobs_pid', getmypid());
+
+	// Work
+	OC_BackgroundJob_Worker::doAllSteps();
+}
+else{
+	if( $appmode == 'cron' ){
+		OC_JSON::error( array( 'data' => array( 'message' => 'Backgroundjobs are using system cron!')));
+	}
+	else{
+		OC_BackgroundJob_Worker::doNextStep();
+		OC_JSON::success();
+	}
+}
+my_temporary_cron_class::$sent = true;
+exit();

db_structure.xml

@@ -506,6 +506,58 @@
 
  </table>
 
+ <table>
+
+  <name>*dbprefix*queuedtasks</name>
+
+  <declaration>
+
+   <field>
+    <name>id</name>
+    <type>integer</type>
+    <default>0</default>
+    <notnull>true</notnull>
+    <autoincrement>1</autoincrement>
+    <unsigned>true</unsigned>
+    <length>4</length>
+   </field>
+
+   <field>
+    <name>app</name>
+    <type>text</type>
+    <default></default>
+    <notnull>true</notnull>
+    <length>255</length>
+   </field>
+
+   <field>
+    <name>klass</name>
+    <type>text</type>
+    <default></default>
+    <notnull>true</notnull>
+    <length>255</length>
+   </field>
+
+   <field>
+    <name>method</name>
+    <type>text</type>
+    <default></default>
+    <notnull>true</notnull>
+    <length>255</length>
+   </field>
+
+   <field>
+    <name>parameters</name>
+    <type>clob</type>
+    <notnull>true</notnull>
+   </field>
+
+
+
+  </declaration>
+
+ </table>
+
  <table>
 
   <name>*dbprefix*users</name>

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;
+	}
+}

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;
+	}
+}

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;
+	}
+}

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" );

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 );
+	}
+}

settings/admin.php

@@ -29,6 +29,7 @@ $tmpl->assign('loglevel',OC_Config::getValue( "loglevel", 2 ));
 $tmpl->assign('entries',$entries);
 $tmpl->assign('entriesremain', $entriesremain);
 $tmpl->assign('htaccessworking',$htaccessworking);
+$tmpl->assign('backgroundjobs_mode', OC_Appconfig::getValue('core', 'backgroundjobs_mode', 'ajax'));
 $tmpl->assign('forms',array());
 foreach($forms as $form){
 	$tmpl->append('forms',$form);

settings/ajax/setbackgroundjobsmode.php

@@ -0,0 +1,31 @@
+<?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/>.
+*
+*/
+
+// Init owncloud
+require_once('../../lib/base.php');
+
+OC_Util::checkAdminUser();
+OCP\JSON::callCheck();
+
+OC_Appconfig::setValue( 'core', 'backgroundjob_mode', $_POST['mode'] );
+
+echo 'true';

settings/js/admin.js

@@ -3,5 +3,11 @@ $(document).ready(function(){
 		$.post(OC.filePath('settings','ajax','setloglevel.php'), { level: $(this).val() },function(){
 			OC.Log.reload();
 		} );
-	})
+	});
+
+	$('#backgroundjobs input').change(function(){
+		if($(this).attr('checked')){
+			$.post(OC.filePath('settings','ajax','setbackgroundjobsmode.php'), { mode: $(this).val() });
+		}
+	});
 });

settings/templates/admin.php

@@ -24,6 +24,19 @@ if(!$_['htaccessworking']) {
 <?php foreach($_['forms'] as $form){
 	echo $form;
 };?>
+
+<fieldset class="personalblock" id="backgroundjobs">
+	<legend><strong><?php echo $l->t('Cron');?></strong></legend>
+	<input type="radio" name="mode" value="none" id="backgroundjobs_none" <?php if( $_['backgroundjobs_mode'] == "none" ){ echo 'checked="checked"'; } ?>>
+	<label for="backgroundjobs_none">None</label><br />
+	<input type="radio" name="mode" value="ajax" id="backgroundjobs_ajax" <?php if( $_['backgroundjobs_mode'] == "ajax" ){ echo 'checked="checked"'; } ?>>
+	<label for="backgroundjobs_ajax">AJAX</label><br />
+	<input type="radio" name="mode" value="webcron" id="backgroundjobs_webcron" <?php if( $_['backgroundjobs_mode'] == "webcron" ){ echo 'checked="checked"'; } ?>>
+	<label for="backgroundjobs_webcron">Webcron</label><br />
+	<input type="radio" name="mode" value="cron" id="backgroundjobs_cron" <?php if( $_['backgroundjobs_mode'] == "cron" ){ echo 'checked="checked"'; } ?>>
+	<label for="backgroundjobs_cron">Cron</label><br />
+</fieldset>
+
 <fieldset class="personalblock">
 	<legend><strong><?php echo $l->t('Log');?></strong></legend>
 	Log level: <select name='loglevel' id='loglevel'>