R48026 - /branches/14.1/phpgwapi/js/jsapi/egw_data.js

hnategh-2 · August 11, 2014, 1:56pm

Author: hnategh
New Revision: 48026

URL: http://svn.stylite.de/viewvc/egroupware?rev=48026&view=rev
Log:
Backport commit r48009, committed by Nathan Gray.
Data improvements:

pass UID as additional parameter to data callbacks
cache actual data separately from cached fetch response to avoid duplication
use callbacks to keep localStorage data consistent with data in memory
use callback to update cached fetch response if a record is removed (set to null)

Modified:
branches/14.1/phpgwapi/js/jsapi/egw_data.js

Modified: branches/14.1/phpgwapi/js/jsapi/egw_data.js
URL: http://svn.stylite.de/viewvc/egroupware/branches/14.1/phpgwapi/js/jsapi/egw_data.js?rev=48026&r1=48025&r2=48026&view=diff

— branches/14.1/phpgwapi/js/jsapi/egw_data.js (original)
+++ branches/14.1/phpgwapi/js/jsapi/egw_data.js Mon Aug 11 15:56:29 2014
@@ -35,6 +35,12 @@
*/
var CACHE_LIFETIME = 29; // seconds

/**
- Cached fetches are differentiated from actual results by using this prefix
- @type String
*/
var CACHE_KEY_PREFIX = ‘cached_fetch_’;
var lastModification = null;

/**
@@ -75,9 +81,11 @@
var indexes = [];
for(var i = 0; i < window.localStorage.length; i++)
{

  	if(window.localStorage.key(i).indexOf('cache_'+_prefix) == 0)

```
  	{
```

  		var key = window.localStorage.key(i);

  	var key = window.localStorage.key(i);

  	// This is a cached fetch for many rows

  	if(key.indexOf(CACHE_KEY_PREFIX+_prefix) == 0)

  	{
  		var cached = JSON.parse(window.localStorage.getItem(key));

  		if(cached.lastModification)

@@ -85,6 +93,23 @@
indexes.push({
key: key,
lastModification: cached.lastModification

```
  			});
```
```
  		}
```
```
  		else
```
```
  		{
```

  			// No way to know how old it is, just remove it

  			window.localStorage.removeItem(key);

```
  		}
```
```
  	}
```
```
  	// Actual cached data
```
```
  	else if (key.indexOf(_prefix) == 0)
```
```
  	{
```

  		var cached = JSON.parse(window.localStorage.getItem(key));

```
  		if(cached.timestamp)
```
```
  		{
```
```
  			indexes.push({
```
```
  				key: key,
```

  				lastModification: cached.timestamp
  			});
  		}
  		else

@@ -181,9 +206,37 @@
var cache_key = false
if(cache_key = cc.callback.call(cc.context, _context))
{

  				cache_key = 'cache_' + _context.prefix + '::' + cache_key;

  				cache_key = CACHE_KEY_PREFIX + _context.prefix + '::' + cache_key;
  				try
  				{

```
  					for (var key in _result.data)
```
```
  					{
```

  						var uid = UID(key, (typeof _context == "object" && _context != null) ? _context.prefix : "");

  						// Register a handler on each data so we can know if it is updated or removed

  						egw.dataUnregisterUID(uid, null, cache_key);

  						egw.dataRegisterUID(uid, function(data, _uid) {

  							// If data item is removed, remove it from cached fetch too

```
  							if(data == null)
```
```
  							{
```

  								var cached = JSON.parse(window.localStorage[this]) || false;

  								if(cached && cached.order && cached.order.indexOf(_uid) >= 0)

```
  								{
```

  									cached.order.splice(cached.order.indexOf(_uid),1);

  									if(cached.total) cached.total--;

  									window.localStorage[this] = JSON.stringify(cached);

```
  								}
```

  								window.localStorage.removeItem(_uid);

```
  							}
```
```
  							else
```
```
  							{
```

  								// Update or store data in long-term storage

  								window.localStorage[_uid] = JSON.stringify({timestamp: (new Date).getTime(), data: data});

```
  							}
```
```
  						},cache_key);
```
```
  					}
```

  					// Don't keep data in long-term cache with request also

  					_result.data = {};
  					window.localStorage.setItem(cache_key,JSON.stringify(_result));
  				}
  				catch (e)

@@ -324,7 +377,7 @@
var cache_key = false
if(cache_key = cc.callback.call(cc.context, _context))
{

  				cache_key = 'cache_' + _context.prefix + '::' + cache_key;

  				cache_key = CACHE_KEY_PREFIX + _context.prefix + '::' + cache_key;

  				var cached = window.localStorage.getItem(cache_key);
  				if(cached)

@@ -388,7 +441,7 @@
/**
* Turn on long-term client side cache of a particular request
* (cache the nextmatch query results) for fast, immediate response

```
   * with old data.
```

   * with old data.  
   *
   * The request is still sent to the server, and the cache is updated
   * with fresh data, and any needed callbacks are called again with

@@ -509,6 +562,9 @@

			// Delete the data from the localStorage
			delete localStorage[uid];

  		// We don't clean long-term storage because of age until it runs

```
  		// out of space
  	}
  }
```
}, CLEANUP_INTERVAL);
@@ -551,7 +607,13 @@
{
// Update the timestamp and call the given callback function
localStorage[_uid].timestamp = (new Date).getTime();

  		_callback.call(_context, localStorage[_uid].data);

  		_callback.call(_context, localStorage[_uid].data, _uid);

```
  	}
```
```
  	// Check long-term storage
```

  	else if(window.localStorage && window.localStorage[_uid])

```
  	{
```

  		localStorage[_uid] = JSON.parse(window.localStorage[_uid]);

  		_callback.call(_context, localStorage[_uid].data, _uid);
  	}
  	else if (_execId && _widgetId)
  	{

@@ -694,7 +756,8 @@
try {
registeredCallbacks[_uid][i].callback.call(
registeredCallbacks[_uid][i].context,

```
  					_data
```

```
  					_data,
```

  					_uid
  				);
  			} catch (e) {
  				// Remove this callback from the list

eGroupWare-cvs mailing list
eGroupWare-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/egroupware-cvs

R48026 - /branches/14.1/phpgwapi/js/jsapi/egw_data.js

Modified: branches/14.1/phpgwapi/js/jsapi/egw_data.js URL: http://svn.stylite.de/viewvc/egroupware/branches/14.1/phpgwapi/js/jsapi/egw_data.js?rev=48026&r1=48025&r2=48026&view=diff

Modified: branches/14.1/phpgwapi/js/jsapi/egw_data.js
URL: http://svn.stylite.de/viewvc/egroupware/branches/14.1/phpgwapi/js/jsapi/egw_data.js?rev=48026&r1=48025&r2=48026&view=diff