app/soc/cache/logic.py
author Sverre Rabbelier <srabbelier@gmail.com>
Sun, 05 Apr 2009 19:37:56 +0000
changeset 2085 2f04b8ec3b96
parent 2070 9555be8634a3
child 2160 3f9dd37d98a8
permissions -rw-r--r--
Use different colors for public/private comment widget Patch by: Dmitri Gaskin <dmitrig01@gmail.com>
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1795
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     1
#!/usr/bin/python2.5
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     2
#
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     3
# Copyright 2009 the Melange authors.
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     4
#
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     5
# Licensed under the Apache License, Version 2.0 (the "License");
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     6
# you may not use this file except in compliance with the License.
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     7
# You may obtain a copy of the License at
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     8
#
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     9
#   http://www.apache.org/licenses/LICENSE-2.0
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    10
#
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    11
# Unless required by applicable law or agreed to in writing, software
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    12
# distributed under the License is distributed on an "AS IS" BASIS,
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    13
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    14
# See the License for the specific language governing permissions and
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    15
# limitations under the License.
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    16
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    17
"""Module contains logic memcaching functions.
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    18
"""
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    19
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    20
__authors__ = [
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    21
    '"Sverre Rabbelier" <sverre@rabbelier.nl>',
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    22
  ]
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    23
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    24
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    25
from google.appengine.api import memcache
1958
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    26
from google.appengine.ext import db
1795
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    27
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    28
import soc.cache.base
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    29
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    30
1958
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    31
def key(model, filter, order):
1795
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    32
  """Returns the memcache key for this query.
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    33
  """
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    34
1958
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    35
  new_filter = {}
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    36
2070
9555be8634a3 Remove unused imports soc.cache.base module and rename key variable to filter_key in soc.views.sitemap modules (access to outer scope names).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1958
diff changeset
    37
  for filter_key, value in filter.iteritems():
1958
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    38
    new_value = value.key().name() if isinstance(value, db.Model) else value
2070
9555be8634a3 Remove unused imports soc.cache.base module and rename key variable to filter_key in soc.views.sitemap modules (access to outer scope names).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1958
diff changeset
    39
    new_filter[filter_key] = new_value
1958
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    40
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    41
  return 'query_for_%(kind)s_%(filter)s_%(order)s' % {
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    42
      'kind': repr(model.kind()),
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    43
      'filter': repr(new_filter),
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    44
      'order': repr(order),
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    45
      }
1795
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    46
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    47
1958
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    48
def get(model, filter, order, *args, **kwargs):
1795
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    49
  """Retrieves the data for the specified query from the memcache.
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    50
  """
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    51
1958
8e8f45dd46e3 Made _getPickData more generic by supporting ordening
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1795
diff changeset
    52
  memcache_key = key(model, filter, order)
1795
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    53
  return memcache.get(memcache_key), memcache_key
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    54
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    55
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    56
def put(data, memcache_key, *args, **kwargs):
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    57
  """Sets the data for the specified query in the memcache.
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    58
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    59
  Args:
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    60
    data: the data to be cached
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    61
  """
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    62
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    63
  # Store data for fifteen minutes to force a refresh every so often
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    64
  retention = 15*60
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    65
  memcache.add(memcache_key, data, retention)
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    66
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    67
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    68
def flush(model, filter):
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    69
  """Removes the data for the current user from the memcache.
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    70
  """
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    71
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    72
  memcache_key = key(model, filter)
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    73
  memcache.delete(memcache_key)
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    74
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    75
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    76
# define the cache function
336c35c82b87 Added query caching
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    77
cache = soc.cache.base.getCacher(get, put)