app/soc/tasks/updates/module_conversion.py
author Lennard de Rijk <ljvderijk@gmail.com>
Thu, 24 Sep 2009 21:17:33 +0200
changeset 2973 ba3f2522e8df
child 2996 9a62e3cad4a8
permissions -rw-r--r--
Added first version of the 1st step in the module conversion process.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2973
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
     1
#!/usr/bin/python2.5
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
     2
#
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
     3
# Copyright 2009 the Melange authors.
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
     4
#
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
     5
# Licensed under the Apache License, Version 2.0 (the "License");
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
     6
# you may not use this file except in compliance with the License.
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
     7
# You may obtain a copy of the License at
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
     8
#
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
     9
#   http://www.apache.org/licenses/LICENSE-2.0
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    10
#
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    11
# Unless required by applicable law or agreed to in writing, software
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    12
# distributed under the License is distributed on an "AS IS" BASIS,
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    13
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    14
# See the License for the specific language governing permissions and
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    15
# limitations under the License.
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    16
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    17
"""The module conversion updates are defined in this module.
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    18
"""
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    19
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    20
__authors__ = [
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    21
  '"Lennard de Rijk" <ljvderijk@gmail.com>',
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    22
  ]
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    23
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    24
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    25
from google.appengine.api.labs import taskqueue
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    26
from google.appengine.ext import db
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    27
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    28
from django.http import HttpResponse
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    29
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    30
from soc.tasks.helper import error_handler
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    31
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    32
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    33
# batch size to use when going through the entities
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    34
DEF_BATCH_SIZE = 10
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    35
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    36
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    37
def startUpdateWithUrl(request, task_url):
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    38
  """Spawns an update task for the given task URL.
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    39
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    40
  Args:
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    41
    request: Django Request object
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    42
    task_url: The URL used to run this update task
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    43
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    44
  Returns:
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    45
    True iff the new task is successfully added to the Task Queue API
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    46
  """
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    47
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    48
  new_task = taskqueue.Task(url=task_url)
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    49
  new_task.add()
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    50
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    51
  return True
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    52
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    53
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    54
def runProgramConversionUpdate(request, *args, **kwargs):
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    55
  """Appengine Task that converts Programs into GSoCPrograms.
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    56
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    57
  The POST dict can contain the key where to start the conversion.
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    58
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    59
  Args:
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    60
    request: Django Request object
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    61
  """
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    62
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    63
  from soc.logic.models.program import logic as program_logic
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    64
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    65
  from soc.modules.gsoc.models.program import GSoCProgram
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    66
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    67
  fields = {}
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    68
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    69
  post_dict = request.POST
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    70
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    71
  start_key = post_dict.get('start_key')
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    72
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    73
  if start_key:
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    74
    # retrieve the last Program entity that was converted
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    75
    start = program_logic.getFromKeyName(start_key)
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    76
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    77
    if not start:
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    78
      # invalid starting key specified, log and return OK
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    79
      return error_handler.logErrorAndReturnOK(
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    80
          'Invalid Program Key specified: %s' %(start_key))
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    81
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    82
    fields['__key__ >'] = start.key()
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    83
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    84
  # get batch_size number of Programs
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    85
  entities = program_logic.getForFields(fields, limit=DEF_BATCH_SIZE)
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    86
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    87
  # get all the properties that are part of each Programs
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    88
  program_model = program_logic.getModel()
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    89
  program_properties = program_model.properties().keys()
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    90
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    91
  # use this to store all the new GSoCPrograms
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    92
  gsoc_programs = []
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    93
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    94
  for entity in entities:
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    95
    gsoc_properties = {}
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    96
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    97
    for program_property in program_properties:
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    98
      # copy over all the information from the program entity
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
    99
      gsoc_properties[program_property] = getattr(entity, program_property)
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   100
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   101
    # create the new GSoCProgram entity and prepare it to be stored
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   102
    gsoc_program_entity = GSoCProgram(key_name=entity.key().name(), **gsoc_properties)
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   103
    gsoc_programs.append(gsoc_program_entity)
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   104
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   105
    # store all the new GSoCPrograms
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   106
    db.put(gsoc_programs)
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   107
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   108
  if len(entities) == DEF_BATCH_SIZE:
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   109
    # spawn new task starting from the last
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   110
    new_start = entities[DEF_BATCH_SIZE-1].key().id_or_name()
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   111
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   112
    # pass along these params as POST to the new task
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   113
    task_params = {'start_key': new_start}
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   114
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   115
    new_task = taskqueue.Task(params=task_params,
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   116
                              url=request.META['PATH_INFO'])
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   117
    new_task.add()
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   118
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   119
  # task completed, return OK
ba3f2522e8df Added first version of the 1st step in the module conversion process.
Lennard de Rijk <ljvderijk@gmail.com>
parents:
diff changeset
   120
  return HttpResponse('OK')