g4l_rlms_vish.py

# -*-*- encoding: utf-8 -*-*-

import re
import sys
import json
import datetime
import uuid
import hashlib
import urllib2
import requests

from wtforms import validators
from flask import Blueprint, url_for
from flask.ext.wtf import TextField, PasswordField, Required, URL, ValidationError

from labmanager.forms import AddForm
from labmanager.rlms import register, Laboratory, Capabilities, register_blueprint
from labmanager.rlms.base import BaseRLMS, BaseFormCreator, Versions

DEFAULT_SEARCH_TYPES = [ 'Excursion' ]
EXAMPLE_SEARCH_TYPES = [ 'Excursion', 'Embed', 'Webapp', 'Swf' ]
DEFAULT_NUMBER = 100

EXCURSION_REGEX = re.compile("Excursion:([0-9]+)@vishub.org")
POS_REGEX = re.compile(".*__([0-9]+)")

class ViSHAddForm(AddForm):

    DEFAULT_LOCATION = u'Europe'
    DEFAULT_URL = u'http://vishub.org/'
    DEFAULT_PUBLICLY_AVAILABLE = True
    DEFAULT_PUBLIC_IDENTIFIER = 'vishub'
    DEFAULT_AUTOLOAD = True

    number = TextField("Number of results", validators = [validators.NumberRange(min=1)], default = DEFAULT_NUMBER)
    search_types = TextField("Search types", description = "Separated by commas, those resources that will be displayed. Example: %s" % (','.join(EXAMPLE_SEARCH_TYPES)), default = ','.join(DEFAULT_SEARCH_TYPES)) 

    def __init__(self, add_or_edit, *args, **kwargs):
        super(ViSHAddForm, self).__init__(*args, **kwargs)
        self.add_or_edit = add_or_edit

class ViSHFormCreator(BaseFormCreator):

    def get_add_form(self):
        return ViSHAddForm

FORM_CREATOR = ViSHFormCreator()

class RLMS(BaseRLMS):

    def __init__(self, configuration):
        self.configuration = json.loads(configuration or '{}')
        self.number = self.configuration.get('number', DEFAULT_NUMBER)
        self.search_types = self.configuration.get('search_types', ','.join(DEFAULT_SEARCH_TYPES))

    def get_version(self):
        return Versions.VERSION_1

    def get_capabilities(self):
        return [ Capabilities.WIDGET, Capabilities.FORCE_SEARCH ] 

    def get_laboratories(self):
        return []

    def search(self, query, page, **kwargs):
        final_query = "http://vishub.org/apis/search?type=%s&n=%s&q=%s" % (urllib2.quote(self.search_types), self.number, urllib2.quote(query))
        results = requests.get(final_query).json()
        laboratories = []
        for result in results['results']:
            laboratories.append(Laboratory(name = u'%s - %s' % (result['type'], result['title']), laboratory_id = result['id'], description = result['description'], autoload = True))

        return {
            'total_results' : len(results),
            'pages' : 1,
            'laboratories' : laboratories,
        }

    def reserve(self, laboratory_id, username, institution, general_configuration_str, particular_configurations, request_payload, user_properties, *args, **kwargs):
        # Only excursions supported right now.
        obj = EXCURSION_REGEX.match(laboratory_id)
        if not obj:
            raise Exception("Invalid identifier: %s" % laboratory_id)
        excursion_identifier = obj.groups()[0]

        return {
            'reservation_id' : laboratory_id,
            'load_url' : 'http://vishub.org/excursions/%s.full' % excursion_identifier
        }

    def list_widgets(self, laboratory_id, **kwargs):
        # Only excursions supported right now.
        obj = EXCURSION_REGEX.match(laboratory_id)
        if not obj:
            raise Exception("Invalid identifier: %s" % laboratory_id)
        excursion_identifier = obj.groups()[0]

        excursion_description = requests.get("http://vishub.org/excursions/%s.json" % excursion_identifier).json()
        widgets = []
        excursion_slides = excursion_description['slides']
        # TODO: sort by name?
        for pos, slide in enumerate(excursion_slides):
            widgets.append({
                'name' : '%s__%s' % (slide['id'], pos),
                'description' : slide['id'],
            })
        return widgets

    def load_widget(self, reservation_id, widget_name, **kwargs):
        number = POS_REGEX.match(widget_name).groups()[0]
        obj = EXCURSION_REGEX.match(reservation_id)
        if not obj:
            return {
                'url' : url_for('vish.index', _external = True)
            }
        excursion_identifier = obj.groups()[0]

        return {
            'url' : 'http://vishub.org/excursions/%s.full#%s?uniq=true' % (excursion_identifier, number)
        }

register("ViSH", ['1.0'], __name__)

vish_blueprint = Blueprint('vish', __name__)
@vish_blueprint.route('/')
def index():
    return "Invalid reservation identifier"

register_blueprint(vish_blueprint, '/vish')