Changeset 16485

Timestamp:

05/28/08 14:05:48 (5 months ago)

Author:

adrenalin

Message:

Added locking feature to prevent simultaneous editing of an object.

Files:

• trunk/midcom/midcom.helper.datamanager2/config/config.inc (modified) (1 diff)
• trunk/midcom/midcom.helper.datamanager2/config/manifest.inc (modified) (1 diff)
• trunk/midcom/midcom.helper.datamanager2/controller.php (modified) (4 diffs)
• trunk/midcom/midcom.helper.datamanager2/controller/ajax.php (modified) (4 diffs)
• trunk/midcom/midcom.helper.datamanager2/controller/simple.php (modified) (4 diffs)
• trunk/midcom/midcom.helper.datamanager2/documentation/CHANGES (modified) (1 diff)
• trunk/midcom/midcom.helper.datamanager2/formmanager.php (modified) (1 diff)
• trunk/midcom/midcom.helper.datamanager2/locale/default.en.txt (modified) (8 diffs)
• trunk/midcom/midcom.helper.datamanager2/locale/default.fi.txt (modified) (8 diffs)

trunk/midcom/midcom.helper.datamanager2/config/config.inc

@@ -126 +126 @@
-),
-'fck_default_config_snippet' => 'file://midcom/helper/datamanager2/config/fckeditor_default.inc',
+
+// Lock timeout, which defines how many seconds the object should be locked
+'lock_timeout' => 1800,

trunk/midcom/midcom.helper.datamanager2/config/manifest.inc

@@ -3 +3 @@
-'state' => 'beta',
-'purecode' => true,
+'privileges' => array
+(
+    'break_lock' => 'midcom.helper.datamanager2:break_lock',
+),
-'package.xml' => array
-(

trunk/midcom/midcom.helper.datamanager2/controller.php

@@ -61 +61 @@
-    var $formmanager = null;
-
+    /**
+     * Lock timeout defines the length of lock in seconds.
+     * 
+     * @access public
+     * @var integer
+     */
+    var $lock_timeout = null;
-
-    /**
@@ -69 +76 @@
-         $this->_component = 'midcom.helper.datamanager2';
-         parent::midcom_baseclasses_components_purecode();
-
-    }
-
@@ -79 +85 @@
-    function initialize()
-    {
+        if (is_null($this->lock_timeout))
+        {
+            $this->lock_timeout = (int) $this->_config->get('lock_timeout');
+        }
+        
-        return true;
-    }
@@ -243 +254 @@
-    function display_form()
-    {
+        if (midcom_helper_datamanager2_controller::is_locked($this->datamanager->storage->object, $this->lock_timeout))
+        {
+            $this->show_remove_lock();
+            return;
+        }
+        
-        $this->formmanager->display_form();
-    }
+    
+    /**
+     * Show the lock status
+     * 
+     * @access public
+     */
+    function show_remove_lock()
+    {
+        if (   function_exists('mgd_is_element_loaded')
+            && mgd_is_element_loaded('midcom_helper_datamanager2_remove_lock'))
+        {
+            mgd_show_element('midcom_helper_datamanager2_remove_lock');
+        }
+        else
+        {
+            $user = $this->datamanager->storage->object->get_parameter('midcom.helper.datamanager2.lock', 'user');
+            $expires = strtotime($this->datamanager->storage->object->get_parameter('midcom.helper.datamanager2.lock', 'expires'));
+            
+            $person = new midcom_db_person($user);
+            ?>
+                <div class="midcom_helper_datamanager2_remove_lock">
+                    <h2><?php echo $this->_l10n->get('object locked'); ?></h2>
+                    <p>
+                        <?php echo sprintf($this->_l10n->get('this object was locked by %s'), $person->name); ?>.
+                        <?php echo sprintf($this->_l10n->get('lock will expire on %s'), strftime('%x %X', $expires)); ?>.
+                    </p>
+            <?php
+            if ($_MIDCOM->auth->can_user_do('midcom.helper.datamanager2:break_lock', null, 'midcom_helper_datamanager2_controller', 'midcom.helper.datamanager2'))
+            {
+                echo "<form method=\"post\">\n";
+                echo "    <p class=\"break_lock\">\n";
+                echo "        <input type=\"hidden\" name=\"midcom_helper_datamanager2_object\" value=\"{$this->datamanager->storage->object->guid}\" />\n";
+                echo "        <input type=\"submit\" name=\"midcom_helper_datamanager2_remove_lock\" value=\"" . $this->_l10n->get('break the lock') . "\" class=\"break_lock\" />\n";
+                echo "    </p>\n";
+                echo "</form>\n";
+            }
+            ?>
+                </div>
+            <?php
+        }
+    }
+    
+    /**
+     * Check if the object is being edited elsewhere
+     * 
+     * @static
+     * @access public
+     * @param mixed $guid      Object or GUID of the object
+     * @return boolean         True if the object is locked
+     */
+    function is_locked($target, $timeout = 0)
+    {
+        // Remove the object lock if applicable
+        if (   isset($_REQUEST['midcom_helper_datamanager2_remove_lock'])
+            && isset($_REQUEST['midcom_helper_datamanager2_object']))
+        {
+            // Get the object
+            $object = $_MIDCOM->dbfactory->get_object_by_guid($_POST['midcom_helper_datamanager2_object']);
+            
+            // Remove the lock, if permission is granted
+            if ($_MIDCOM->auth->can_user_do('midcom.helper.datamanager2:break_lock', null, 'midcom_helper_datamanager2_controller', 'midcom.helper.datamanager2'))
+            {
+                midcom_helper_datamanager2_controller::set_lock($object, $timeout);
+            }
+            else
+            {
+                $_MIDCOM->uimessages->add($_MIDCOM->i18n->get_string('midcom.helper.datamanager2', 'midcom.helper.datamanager2'), $_MIDCOM->i18n->get_string('permission denied', 'midcom'), 'error');
+            }
+        }
+        
+        // Check that we have an object at disposal
+        if (is_object($target))
+        {
+            $object =& $target;
+        }
+        else
+        {
+            $object = $_MIDCOM->dbfactory->get_object_by_guid($target);
+        }
+        
+        // Couldn't get the object. Different error handling here? Controller should have already alarmed the user, though...
+        if (   !$object
+            || !$object->guid)
+        {
+            return false;
+        }
+        
+        $expires = (int) strtotime($object->get_parameter('midcom.helper.datamanager2.lock', 'expires'));
+        
+        // Object not locked, allow editing
+        if (!$expires)
+        {
+            return false;
+        }
+        
+        // Get the person who locked the object
+        $user = $object->get_parameter('midcom.helper.datamanager2.lock', 'user');
+        
+        // Lock was created by the user, allow unquestionable editing
+        if (   isset($_MIDCOM->auth->user)
+            && isset($_MIDCOM->auth->user->guid)
+            && $user === $_MIDCOM->auth->user->guid)
+        {
+            return false;
+        }
+        
+        // Object lock is no longer valid
+        if (time() > $expires)
+        {
+            return false;
+        }
+        
+        // Lock checked, object locked
+        return true;
+    }
+    
+    /**
+     * Set the object lock
+     * 
+     * @static
+     * @access public
+     * @param mixed $object    Object that should be locked
+     * @param int $timeout     Length of the lock timeout
+     */
+    function set_lock($object, $timeout)
+    {
+        if ((int) $timeout < 1)
+        {
+            $object->set_parameter('midcom.helper.datamanager2.lock', 'user', '');
+            $object->set_parameter('midcom.helper.datamanager2.lock', 'expires', '');
+            return true;
+        }
+        
+        $object->set_parameter('midcom.helper.datamanager2.lock', 'user', $_MIDCOM->auth->user->guid);
+        $object->set_parameter('midcom.helper.datamanager2.lock', 'expires', strftime('%Y-%m-%d %H:%M:%S', time() + $timeout));
+        
+        return true;
+    }
-}
+?>

trunk/midcom/midcom.helper.datamanager2/controller/ajax.php

@@ -28 +28 @@
-    
-    /**
-
+ and connects to the parent class initialization.
-     *
-     * @return boolean Indicating success.
@@ -34 +34 @@
-    function initialize()
-    {
+        parent::initialize();
+        
-        if (count($this->schemadb) == 0)
-        {
@@ -286 +288 @@
-        $result = $this->formmanager->process_form();
-
+        // Remove the lock
+        if (   $result === 'save'
+            || $result === 'cancel')
+        {
+            midcom_helper_datamanager2_controller::set_lock($this->datamanager->storage->object, 0);
+        }
+        // or set it, if needed
+        elseif (!midcom_helper_datamanager2_controller::is_locked($this->datamanager->storage->object, $this->lock_timeout))
+        {
+            midcom_helper_datamanager2_controller::set_lock($this->datamanager->storage->object, $this->lock_timeout);
+        }
+        
-        // Handle successful save explicitly.
-        if (   $result == 'save'
@@ -326 +340 @@
-        return $result;
-    }
-
-}
-
-?>

trunk/midcom/midcom.helper.datamanager2/controller/simple.php

@@ -23 +23 @@
-{
-    /**
-Empty default implementation, this calls won't do much.
+Check if a schema has been set
-     *
-     * @return boolean Indicating success.
@@ -29 +29 @@
-    function initialize()
-    {
+        parent::initialize();
+        
-        if (count($this->schemadb) == 0)
-        {
@@ -86 +88 @@
-        $result = $this->formmanager->process_form();
-        
+        // Remove the lock
+        if (   $result === 'save'
+            || $result === 'cancel')
+        {
+            midcom_helper_datamanager2_controller::set_lock($this->datamanager->storage->object, 0);
+        }
+        // or set it, if needed
+        elseif (!midcom_helper_datamanager2_controller::is_locked($this->datamanager->storage->object, $this->lock_timeout))
+        {
+            midcom_helper_datamanager2_controller::set_lock($this->datamanager->storage->object, $this->lock_timeout);
+        }
+        
-        // Handle successful save explicitly.
-        if (   $result == 'save'
@@ -131 +145 @@
-        return $result;
-    }
-
-}
-
-?>

trunk/midcom/midcom.helper.datamanager2/documentation/CHANGES

@@ -8 +8 @@
-  which might even break existing functionality.
-- All items marked with "+" represent completely new features.
+
+2008-05-28 adrenalin
+  + Added locking feature for disabling simultaneous editing
-
-2008-02-12 adrenalin

trunk/midcom/midcom.helper.datamanager2/formmanager.php

@@ -1000 +1000 @@
-    function get_clicked_button()
-    {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-}
+?>

trunk/midcom/midcom.helper.datamanager2/locale/default.en.txt

@@ -16 +16 @@
----STRINGEND
-
+---STRING add new file
+Add a new file
+---STRINGEND
+
----STRING archived image
-Archived image
@@ -53 +57 @@
----STRINGEND
-
+---STRING drag and drop to sort
+Drag and drop to sort
+---STRINGEND
+
----STRING field %s is required
-The field %s is required, please fill it out.
@@ -73 +81 @@
----STRINGEND
-
+---STRING lock will expire on %s
+Lock will expire on %s
+---STRINGEND
+
----STRING midcom.helper.datamanager2
-Data management and form rendering library
@@ -81 +93 @@
----STRINGEND
-
+---STRING object locked
+Object locked
+---STRINGEND
+
----STRING passwords do not match
-The passwords do not match.
@@ -101 +117 @@
----STRINGEND
-
+---STRING this object was locked by %s
+This object was locked by %s
+---STRINGEND
+
----STRING type blobs: file size
-File size
@@ -117 +137 @@
----STRINGEND
-
+---STRING type number: value must not be larger then %s
+The value of this field may not be larger then %s.
+---STRINGEND
+
+---STRING type number: value must not be smaller then %s
+The value of this field may not be smaller then %s.
+---STRINGEND
+
----STRING type php: parse error in line %s
-Parse Error in line %s
----STRINGEND
-
----STRING type number: value must not be larger then %s
-The value of this field may not be larger then %s.
----STRINGEND
-
----STRING type number: value must not be smaller then %s
-The value of this field may not be smaller then %s.
----STRINGEND
-
----STRING type select: multiselect not allowed
-No multiple selection allowed for this field.
@@ -153 +173 @@
----STRINGEND
-
----STRING add new file
-Add a new file
----STRINGEND
-
----STRING upload image
-Upload image
@@ -221 +237 @@
----STRINGEND
-
-drag and drop to sort
-
-
-
+break the lock
+
+
+

trunk/midcom/midcom.helper.datamanager2/locale/default.fi.txt

@@ -16 +16 @@
----STRINGEND
-
+---STRING add new file
+
+---STRINGEND
+
----STRING archived image
-Arkistoitu kuva
@@ -52 +56 @@
----STRINGEND
-
+---STRING drag and drop to sort
+JÀrjestele hiirellÀ raahaamalla
+---STRINGEND
+
----STRING field %s is required
-KenttÀ %s on pakollinen, ole hyvÀ ja tÀytÀ se.
@@ -72 +80 @@
----STRINGEND
-
+---STRING lock will expire on %s
+Lukko avautuu ajalla %s
+---STRINGEND
+
----STRING midcom.helper.datamanager2
-Tiedonhallinta- ja lomakekirjasto
@@ -80 +92 @@
----STRINGEND
-
+---STRING object locked
+Kohde lukittu
+---STRINGEND
+
----STRING passwords do not match
-Salasanat eivÀt tÀsmÀÀ
@@ -100 +116 @@
----STRINGEND
-
+---STRING this object was locked by %s
+TÀmÀn kohteen lukitsi %s
+---STRINGEND
+
----STRING type blobs: file size
-Tiedoston koko
@@ -124 +144 @@
----STRINGEND
-
+---STRING type php: parse error in line %s
+
+---STRINGEND
+
----STRING type select: multiselect not allowed
-Monivalinta ei ole sallittu
@@ -156 +180 @@
----STRINGEND
-
+---STRING validation failed: date
+
+---STRINGEND
+
----STRING validation failed: email
-TÀmÀ ei ole oikea sÀhköpostiosoite
@@ -208 +236 @@
----STRINGEND
-
-drag and drop to sort
-
-
-
+break the lock
+
+
+