model.py

#    Copyright (C) 2006, 2007, 2008 One Laptop Per Child
#
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program; if not, write to the Free Software
#    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#

import os
import shutil
from xml.etree.ElementTree import Element, SubElement, tostring, parse
from os import environ, makedirs, chmod
from os.path import join, basename, isdir, split, normpath, exists
import logging
import random
from gi.repository import GObject
import zipfile
import tempfile

from sugar3.activity.activity import get_activity_root

ART4APPS_IMAGE_PATH = ''
ART4APPS_AUDIO_PATH = ''
USE_ART4APPS = False
art4apps_data = None
try:
    import art4apps
    USE_ART4APPS = True
    ART4APPS_IMAGE_PATH = art4apps.IMAGES_PATH
    ART4APPS_AUDIO_PATH = art4apps.AUDIO_PATH
    art4apps_data = art4apps.Art4Apps()
except ImportError:
    pass


DEFAULT_FONT = 'Sans'


class Pair(GObject.GObject):
    __gproperties__ = {
        'aimg': (str, None, None, None, GObject.PARAM_READWRITE),
        'asnd': (str, None, None, None, GObject.PARAM_READWRITE),
        'achar': (str, None, None, None, GObject.PARAM_READWRITE),
        'bimg': (str, None, None, None, GObject.PARAM_READWRITE),
        'bsnd': (str, None, None, None, GObject.PARAM_READWRITE),
        'bchar': (str, None, None, None, GObject.PARAM_READWRITE),
        'aspeak': (str, None, None, None, GObject.PARAM_READWRITE),
        'bspeak': (str, None, None, None, GObject.PARAM_READWRITE),
        'color': (GObject.TYPE_INT, 'Base', 'Base', 0, 10, 0,
                  GObject.PARAM_READWRITE)
    }

    def __init__(self):
        GObject.GObject.__init__(self)
        self._properties = {'aimg': None, 'asnd': None, 'achar': None,
                            'bimg': None, 'bsnd': None, 'bchar': None,
                            'color': 100, 'aspeak': None, 'bspeak': None}

    def do_get_property(self, pspec):
        """Retrieve a particular property from our property dictionary
        """
        if pspec.name == "aimg":
            return self._properties["aimg"]
        elif pspec.name == "asnd":
            return self._properties["asnd"]
        elif pspec.name == "achar":
            return self._properties["achar"]
        elif pspec.name == "bimg":
            return self._properties["bimg"]
        elif pspec.name == "bsnd":
            return self._properties["bsnd"]
        elif pspec.name == "bchar":
            return self._properties["bchar"]
        elif pspec.name == "color":
            return self._properties["color"]
        elif pspec.name == "aspeak":
            return self._properties["aspeak"]
        elif pspec.name == "bspeak":
            return self._properties["bspeak"]

    def set_property(self, name, value):
        if name == 'aimg':
            self._properties['aimg'] = value
        elif name == "asnd":
            self._properties["asnd"] = value
        elif name == "achar":
            self._properties["achar"] = value
        elif name == "bimg":
            self._properties["bimg"] = value
        elif name == "bsnd":
            self._properties["bsnd"] = value
        elif name == "bchar":
            self._properties["bchar"] = value
        elif name == "color":
            self._properties["color"] = value
        elif name == "aspeak":
            self._properties["aspeak"] = value
        elif name == "bspeak":
            self._properties["bspeak"] = value


class Model(object):
    ''' The model of the activity. Contains methods to read and write
    the configuration for a game from xml. Stores the pairs and grid
    information.
    '''

    def __init__(self, game_path=None):
        tmp_root = join(environ['SUGAR_ACTIVITY_ROOT'], 'instance')
        self.temp_folder = tempfile.mkdtemp(dir=tmp_root)
        chmod(self.temp_folder, 0777)

        self.data = {}

        if game_path is None:
            game_path = get_activity_root()

        if isdir(game_path):
            self.game_path = game_path
        else:
            logging.error('Game_path not found in %s' % game_path)
            return

        self.data['face'] = ''
        self.data['align'] = '1'
        self.data['divided'] = '0'
        self.data['equal_pairs'] = '0'
        self.data['font_name1'] = DEFAULT_FONT
        self.data['font_name2'] = DEFAULT_FONT

        self.pairs = {}
        self.grid = []

        # used to know if the game should be saved and reloaded
        self.modified = False
        logging.debug('Model init is_demo False')
        self.is_demo = False

        # used by the leader of the game to keep track of the game state
        self.players = {}
        self.player_active = 0
        self.selected = 0
        self.turn = 0
        self.started = 0
        self.count = 0

    def mark_modified(self):
        logging.debug('Model mark_modified is_demo False')
        self.is_demo = False
        self.modified = True
        self.data['mode'] = 'file'

    def read(self, game_file):
        self.modified = False
        self.count = 0
        self.data['key'] = basename(game_file)
        self.data['game_file'] = game_file
        self.data['path'] = self.temp_folder
        self.data['pathimg'] = join(self.data['path'], 'images')
        self.data['pathsnd'] = join(self.data['path'], 'sounds')

        ''' extracts files in the zip file '''
        zipFile = zipfile.ZipFile(game_file, "r")
        for each in zipFile.namelist():
            if not each.endswith('/'):
                root, name = split(each)
                directory = normpath(join(self.data['path'], root))
                if not isdir(directory):
                    makedirs(directory)
                file(join(directory, name), 'wb').write(zipFile.read(each))

        self.pairs = {}

        ''' reads the configuration from an xml file '''
        try:
            xml_file = join(environ['SUGAR_ACTIVITY_ROOT'],
                            self.data['path'], 'game.xml')
            doc = parse(xml_file)
            if doc:

                memorize_elem = doc.getroot()
                attributes = memorize_elem.attrib
                if 'name' in attributes:
                    self.data['name'] = attributes['name']
                if 'scoresnd' in attributes:
                    self.data['scoresnd'] = attributes['scoresnd']
                if 'winsnd' in attributes:
                    self.data['winsnd'] = attributes['winsnd']
                if 'divided' in attributes:
                    self.data['divided'] = attributes['divided']
                if 'face' in attributes:
                    self.data['face'] = attributes['face']
                if 'face1' in attributes:
                    self.data['face1'] = attributes['face1']
                if 'face2' in attributes:
                    self.data['face2'] = attributes['face2']
                if 'align' in attributes:
                    self.data['align'] = attributes['align']
                if 'equal_pairs' in attributes:
                    self.data['equal_pairs'] = attributes['equal_pairs']
                if 'font_name1' in attributes:
                    self.data['font_name1'] = attributes['font_name1']
                if 'font_name2' in attributes:
                    self.data['font_name2'] = attributes['font_name2']
                if 'origin' in attributes:
                    self.data['origin'] = attributes['origin']
                    if self.data['origin'] == 'art4apps':
                        self.data['pathimg'] = ART4APPS_IMAGE_PATH
                        if 'language' in attributes:
                            language = attributes['language']
                        else:
                            language = 'en'
                        self.data['pathsnd'] = join(ART4APPS_AUDIO_PATH,
                                                    language)

                idpair = 0
                for elem in memorize_elem.getchildren():
                    attributes = elem.attrib
                    pair = Pair()
                    for attribute in attributes.keys():
                        if(attribute == 'text'):
                            pass
                        else:
                            pair.set_property(attribute,
                                              attributes[attribute])
                    self.pairs[str(idpair)] = pair
                    idpair += 1

            else:
                logging.error('Read: Error in validation of the file')
                return 1
            return 0
        except Exception as e:
            logging.error('Read: Error parsing file ' + str(e))
            return 2

    def read_art4apps(self, category, language):
        """
        Create a game dinamically, based in the art4apps resources
        """

        self.modified = False
        self.count = 0
        self.data['game_file'] = '%s_%s' % (category, language)
        self.data['origin'] = 'art4apps'
        self.data['language'] = language
        self.data['path'] = self.temp_folder
        self.data['pathimg'] = ART4APPS_IMAGE_PATH
        self.data['pathsnd'] = join(ART4APPS_AUDIO_PATH, language)

        idpair = 0
        self.pairs = {}
        for word in art4apps_data.get_words_by_category(category):
            image_filename = art4apps_data.get_image_filename(word)
            if os.path.exists(image_filename):
                pair = Pair()
                label = word
                if language != 'en':
                    label = art4apps_data.get_translation(word, language)
                pair.set_property('achar', label)
                pair.set_property('bimg', basename(image_filename))

                snd_filename = art4apps_data.get_audio_filename(word,
                                                                language)
                if snd_filename is not None:
                    pair.set_property('asnd', basename(snd_filename))
                else:
                    aspeak = language
                    if language == 'en':
                        aspeak = "en-us"
                    elif language == 'es':
                        aspeak = "es-la"
                    elif language == 'fr':
                        aspeak = "fr-fr"

                    pair.set_property('aspeak', aspeak)
                self.pairs[str(idpair)] = pair
                idpair += 1
        self.data['divided'] = '1'
        self.data['face1'] = '1'
        self.data['face2'] = '2'
        self.data['equal_pairs'] = '0'
        self.data['font_name1'] = 'Sans'
        self.data['font_name2'] = 'Sans'
        return 0

    def write(self):
        ''' writes the configuration to an xml file '''
        game_props = {}
        if(self.data.get('name', None) is not None):
            game_props["name"] = self.data['name']

        if(self.data.get('divided', None) is not None):
            game_props['divided'] = '1'
            game_props['face1'] = '1'
            game_props['face2'] = '2'
        else:
            game_props['divided'] = '0'

        if 'origin' in self.data:
            game_props['origin'] = self.data['origin']
        if 'language' in self.data:
            game_props['language'] = self.data['language']

        if(self.data.get('equal_pairs', None) is not None):
            game_props['equal_pairs'] = self.data['equal_pairs']
        if(self.data.get('font_name1', None) is not None):
            game_props['font_name1'] = self.data['font_name1']
        if(self.data.get('font_name2', None) is not None):
            game_props['font_name2'] = self.data['font_name2']
        if(self.data.get('scoresnd', None) is not None):
            game_props["scoresnd"] = self.data['scoresnd']
        if(self.data.get('winsnd', None) is not None):
            game_props["winsnd"] = self.data['winsnd']
        if(self.data.get('divided', None) is not None):
            game_props["divided"] = self.data['divided']
        if(self.data.get('face', None) is not None):
            game_props["face"] = self.data['face']
        if(self.data.get('face1', None) is not None):
            game_props["face1"] = self.data['face1']
        if(self.data.get('face2', None) is not None):
            game_props["face2"] = self.data['face2']
        if(self.data.get('align', None) is not None):
            game_props["align"] = self.data['align']

        root = Element("memorize", game_props)

        for key in self.pairs:
            pair_props = {}
            if self.pairs[key].props.aimg is not None:
                pair_props["aimg"] = self.pairs[key].props.aimg
            if self.pairs[key].props.asnd is not None:
                pair_props["asnd"] = self.pairs[key].props.asnd
            if self.pairs[key].props.achar is not None:
                pair_props["achar"] = self.pairs[key].props.achar
            if self.pairs[key].props.bimg is not None:
                pair_props["bimg"] = self.pairs[key].props.bimg
            if self.pairs[key].props.bsnd is not None:
                pair_props["bsnd"] = self.pairs[key].props.bsnd
            if self.pairs[key].props.bchar is not None:
                pair_props["bchar"] = self.pairs[key].props.bchar
            if self.pairs[key].props.aspeak is not None:
                pair_props["aspeak"] = self.pairs[key].props.aspeak
            if self.pairs[key].props.bspeak is not None:
                pair_props["bspeak"] = self.pairs[key].props.bspeak
            SubElement(root, 'pair', pair_props)

        logging.error(tostring(root))

        try:
            with open(join(self.game_path, 'game.xml'), 'w') as xml_file:
                xml_file.write(tostring(root))
        except:
            return 2
        return 0

    def def_grid(self, size):
        ''' create the grid for the play from the pairs information
        and shuffles the grid so they always appear in a different
        place
        '''
        psize = (size * size / 2)
        logging.debug('Size requested: %d', psize)
        self.grid = []
        temp1 = []
        temp2 = []
        i = 0

        # shuffle the pairs first to avoid only taking the first ones
        # when there are more pairs in the config file then the grid is using
        keys = self.pairs.keys()
        random.shuffle(keys)

        for key in keys:
            if i < psize:
                elem = {}
                elem['pairkey'] = str(key)
                elem['state'] = '0'
                elem['ab'] = 'a'
                if self.pairs[key].props.aimg is not None:
                    elem['img'] = self.pairs[key].props.aimg
                if self.pairs[key].props.asnd is not None:
                    elem['snd'] = self.pairs[key].props.asnd
                if self.pairs[key].props.achar is not None:
                    elem['char'] = self.pairs[key].props.achar
                if self.pairs[key].props.aspeak is not None:
                    elem['speak'] = self.pairs[key].props.aspeak
                temp1.append(elem)

                elem = {}
                elem['pairkey'] = str(key)
                elem['state'] = '0'
                elem['ab'] = 'b'
                if self.pairs[key].props.bimg is not None:
                    elem['img'] = self.pairs[key].props.bimg
                if self.pairs[key].props.bsnd is not None:
                    elem['snd'] = self.pairs[key].props.bsnd
                if self.pairs[key].props.bchar is not None:
                    elem['char'] = self.pairs[key].props.bchar
                if self.pairs[key].props.bspeak is not None:
                    elem['speak'] = self.pairs[key].props.bspeak
                temp2.append(elem)
                i += 1
            else:
                break

        numpairs = len(self.pairs)
        if numpairs < psize:
            logging.debug('Defgrid: Not enough pairs, requested=%s had=%s'
                          % (psize, numpairs))
        self.data['size'] = str(size)

        if self.data['divided'] == '1':
            random.shuffle(temp1)
            random.shuffle(temp2)
            temp1.extend(temp2)
        else:
            temp1.extend(temp2)
            random.shuffle(temp1)
        self.grid = temp1
        logging.debug('Defgrid: grid( size=%s ): %s'
                      % (self.data['size'], self.grid))
        logging.debug('Defgrid: data: %s', self.data)

    def set_data_grid(self, data, grid):
        self.data = data
        self.grid = grid

    def create_temp_directories(self):
        logging.error('creating temp directories model: %s', self.data)
        temp_img_folder = join(self.temp_folder, 'images')
        temp_snd_folder = join(self.temp_folder, 'sounds')

        if 'origin' in self.data and self.data['origin'] == 'art4apps':

            if not self.modified:
                # if was not modified, don't change the temp directtories
                return
            else:
                # we need copy the files used in the game to the new path
                if not exists(temp_img_folder):
                    makedirs(temp_img_folder)
                if not exists(temp_snd_folder):
                    makedirs(temp_snd_folder)
                for key in self.pairs.keys():
                    # all the images exist, but not all the sounds
                    for img in (self.pairs[key].props.aimg,
                                self.pairs[key].props.bimg):
                        if img is not None:
                            origin_path = join(ART4APPS_IMAGE_PATH, img)
                            destination_path = join(temp_img_folder, img)
                            if not os.path.exists(destination_path):
                                shutil.copyfile(origin_path, destination_path)
                            logging.error('copy %s to %s', origin_path,
                                          destination_path)

                    for snd in (self.pairs[key].props.asnd,
                                self.pairs[key].props.bsnd):
                        if snd is not None:
                            origin_path = join(ART4APPS_AUDIO_PATH,
                                               self.data['language'], snd)
                            destination_path = join(temp_snd_folder, snd)
                            if os.path.exists(origin_path) and \
                                    not os.path.exists(destination_path):
                                shutil.copyfile(origin_path, destination_path)
                            logging.error('copy %s to %s', origin_path,
                                          destination_path)
                # Don't look for the images in the art4apps directory
                # after this
                self.data['origin'] = ''

        self.data['pathimg'] = temp_img_folder
        self.data['pathsnd'] = temp_snd_folder

        if not exists(temp_img_folder):
            makedirs(temp_img_folder)
        if not exists(temp_snd_folder):
            makedirs(temp_snd_folder)