ProcessxAPISGStatement.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "***process_xapisg_statement* function** receives an xAPI-SG statement and updates the dictionary of players information\n",
    "\n",
    "\n",
    "Inputs:\n",
    "* data : xAPI-SG statement\n",
    "* players_info: dictionary with players info\n",
    "* timeformats: list of timeformats for timestamp"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "# template with default information for each player\n",
    "template_player_info = {\n",
    "    \"game_started\": False, \"game_completed\": False,\n",
    "    \"interactions\":{}, # dict of interactions\n",
    "    \"game_progress_per_time\": [], # list of pairs (game progress, timestamp)\n",
    "    \"completables_scores\": {}, # dict completable : last score\n",
    "    \"completables_progress\": {}, # list of pairs completable : last progress\n",
    "    \"completables_times\": {}, # dict completable: (start, end)\n",
    "    \"alternatives\": {}, # dict alternative: list of pairs (response, correct (T/F))\n",
    "    \"action_type_interaction\":{}, # dict of action type interactions\n",
    "    \"accessible\":{}, # dict of accessible\n",
    "    \"videos_seen\": [], # list of videos seen (accessed) by player\n",
    "    \"videos_skipped\": [], # list of videos skipped by player\n",
    "    \"selected_menus\":{} # dict of menus and response selected\n",
    "}\n",
    "\n",
    "def process_xapisg_statement(data, players_info, timeformats):\n",
    "    # available keys in statement\n",
    "    keys = data.keys()\n",
    "\n",
    "    ## extracting fields from xAPI-SG statement\n",
    "    # actor field\n",
    "    if \"actor\" in keys:\n",
    "        if \"name\" in data[\"actor\"].keys():\n",
    "            actor_name = data[\"actor\"][\"name\"]\n",
    "\n",
    "            if actor_name not in players_info.keys():\n",
    "                players_info[actor_name] = copy.deepcopy(template_player_info)\n",
    "\n",
    "            player_info = players_info[actor_name]\n",
    "\n",
    "    # verb field\n",
    "    if \"verb\" in keys:\n",
    "        if \"id\" in data[\"verb\"].keys():\n",
    "            verb_id = data[\"verb\"][\"id\"]\n",
    "            # process verb field\n",
    "            verb_xapi = np.array(verb_id.split(\"/\"))[-1]\n",
    "\n",
    "    # object field\n",
    "    if \"object\" in keys:\n",
    "        if \"id\" in data[\"object\"].keys():\n",
    "            object_id = data[\"object\"][\"id\"]\n",
    "            # process object id field\n",
    "            object_id_name = np.array(object_id.split(\"/\"))[-1]\n",
    "        if \"definition\" in data[\"object\"].keys() and \"type\" in data[\"object\"][\"definition\"].keys():\n",
    "            object_type = data[\"object\"][\"definition\"][\"type\"]\n",
    "            # process object type field\n",
    "            object_type_xapi = np.array(object_type.split(\"/\"))[-1]\n",
    "    action_type=None\n",
    "    # result field\n",
    "    if \"result\" in keys:\n",
    "        if \"extensions\" in data[\"result\"].keys():\n",
    "            if \"response\" in data[\"result\"].keys():\n",
    "                result_response = data[\"result\"][\"response\"]\n",
    "            res = data[\"result\"][\"extensions\"]\n",
    "        else:\n",
    "            res = data[\"result\"]\n",
    "        if \"success\" in res.keys():\n",
    "            result_success = res[\"success\"]\n",
    "        if \"response\" in res.keys():\n",
    "            result_response = res[\"response\"]\n",
    "        if \"progress\" in res.keys():\n",
    "            result_progress = res[\"progress\"]\n",
    "        elif \"https://w3id.org/xapi/seriousgames/extensions/progress\" in res.keys():\n",
    "            result_progress = res[\"https://w3id.org/xapi/seriousgames/extensions/progress\"]\n",
    "        if \"score\" in res.keys():\n",
    "            if(isinstance(res[\"score\"],dict)):\n",
    "                result_score = res[\"score\"][\"raw\"]\n",
    "            else:\n",
    "                result_score = res[\"score\"]\n",
    "        if \"action_type\" in res.keys():\n",
    "            action_type=res[\"action_type\"]\n",
    "\n",
    "    # timestamp field\n",
    "    if \"timestamp\" in keys:\n",
    "        timestamp = data[\"timestamp\"]\n",
    "        try:\n",
    "            t=timestampTotimedate(timestamp, timeformats)\n",
    "        except TimeFormatError as e:\n",
    "            print(e)\n",
    "        \n",
    "    ## update values\n",
    "    try:\n",
    "        # initialized traces\n",
    "        if verb_xapi.lower()==\"initialized\":\n",
    "            if object_type_xapi.lower()==\"serious-game\":\n",
    "                player_info[\"game_started\"] = True\n",
    "                if timestamp: player_info[\"game_progress_per_time\"].append([0,t])\n",
    "\n",
    "            if timestamp: player_info[\"completables_times\"][object_id_name] = (t, 0) # (start, end) times\n",
    "\n",
    "        # completed traces\n",
    "        elif verb_xapi.lower()==\"completed\":\n",
    "            if object_type_xapi.lower()==\"serious-game\":\n",
    "                player_info[\"game_completed\"] = True\n",
    "                if timestamp: player_info[\"game_progress_per_time\"].append([1,t])\n",
    "\n",
    "            if timestamp and object_id_name in player_info[\"completables_times\"].keys():\n",
    "                prev = player_info[\"completables_times\"][object_id_name][0]\n",
    "                player_info[\"completables_times\"][object_id_name] = (prev, t) # update end time\n",
    "            if object_id_name and timestamp and result_score:\n",
    "                player_info[\"completables_scores\"][object_id_name] = result_score\n",
    "                \n",
    "        # progressed traces\n",
    "        elif verb_xapi.lower()==\"progressed\":\n",
    "            if object_type_xapi.lower()==\"serious-game\" and timestamp and result_progress:\n",
    "                player_info[\"game_progress_per_time\"].append([result_progress,t])\n",
    "                if result_progress==1:\n",
    "                    player_info['game_completed'] = True\n",
    "                    \n",
    "            if verb_xapi.lower()==\"progressed\" and object_id_name and result_progress:\n",
    "                if not object_id_name in player_info[\"completables_progress\"].keys():\n",
    "                    player_info[\"completables_progress\"][object_id_name]=[]\n",
    "                player_info[\"completables_progress\"][object_id_name].append([result_progress,t])\n",
    "                \n",
    "        # interacted and used traces\n",
    "        elif verb_xapi.lower()==\"interacted\" or verb_xapi.lower()==\"used\":\n",
    "            if action_type!=None:\n",
    "                if not object_type_xapi in player_info[\"action_type_interaction\"].keys():\n",
    "                    player_info[\"action_type_interaction\"][object_type_xapi]={}\n",
    "\n",
    "                if not object_id_name in player_info[\"action_type_interaction\"][object_type_xapi].keys():\n",
    "                    player_info[\"action_type_interaction\"][object_type_xapi][object_id_name]={}\n",
    "                    \n",
    "                if not action_type in player_info[\"action_type_interaction\"][object_type_xapi][object_id_name].keys():\n",
    "                    player_info[\"action_type_interaction\"][object_type_xapi][object_id_name][action_type]=[]\n",
    "                    \n",
    "                player_info[\"action_type_interaction\"][object_type_xapi][object_id_name][action_type].append(t)\n",
    "                \n",
    "            else:\n",
    "                if not object_type_xapi in player_info[\"interactions\"].keys():\n",
    "                    player_info[\"interactions\"][object_type_xapi]={}\n",
    "                    \n",
    "                if not object_id_name in player_info[\"interactions\"][object_type_xapi].keys():\n",
    "                    player_info[\"interactions\"][object_type_xapi][object_id_name]=[]\n",
    "                    \n",
    "                player_info[\"interactions\"][object_type_xapi][object_id_name].append(t)\n",
    "                \n",
    "        # selected traces\n",
    "        elif verb_xapi.lower()==\"selected\":\n",
    "            if object_type_xapi.lower()==\"alternative\":\n",
    "                if object_id_name and result_response and result_success is not None: # success = false is valid!\n",
    "                    if object_id_name in player_info[\"alternatives\"].keys():\n",
    "                        player_info[\"alternatives\"][object_id_name].append((result_response, result_success))\n",
    "                    else:\n",
    "                        player_info[\"alternatives\"][object_id_name] = [(result_response, result_success)]\n",
    "                        \n",
    "            elif object_type_xapi.lower()==\"menu\":\n",
    "                if result_response:\n",
    "                    if not object_id_name in player_info[\"selected_menus\"].keys():\n",
    "                        player_info[\"selected_menus\"][object_id_name]={}\n",
    "                    if not result_response in player_info[\"selected_menus\"][object_id_name].keys():\n",
    "                        player_info[\"selected_menus\"][object_id_name][result_response]=[]\n",
    "                    if timestamp:\n",
    "                        t=timestampTotimedate(timestamp, timeformats)\n",
    "                        player_info[\"selected_menus\"][object_id_name][result_response].append(t)\n",
    "        # accessed traces\n",
    "        elif verb_xapi.lower()==\"accessed\":\n",
    "            if object_type_xapi.lower()==\"cutscene\" and object_id_name:\n",
    "                player_info[\"videos_seen\"].append(object_id_name)\n",
    "            elif object_type_xapi.lower()==\"accessible\" and object_id_name:\n",
    "                if not object_id_name in player_info[\"accessible\"].keys():\n",
    "                    player_info[\"accessible\"][object_id_name]=[]\n",
    "                t=timestampTotimedate(timestamp, timeformats)\n",
    "                player_info[\"accessible\"][object_id_name].append(t)\n",
    "        # skipped traces\n",
    "        elif verb_xapi.lower()==\"skipped\":\n",
    "            if object_type_xapi.lower()==\"cutscene\" and object_id_name:\n",
    "                player_info[\"videos_skipped\"].append(object_id_name)\n",
    "    except NameError:\n",
    "        pass#%% md"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "***timestampTotimedate* function** to tranform the timestamp in datetime\n",
    "Inputs:\n",
    "* timestamp : the time in a string\n",
    "* timeformats : an array of timeformat witch match the timestamp with\n",
    "\n",
    "Output:\n",
    "* return t : dateTime\n",
    "* raise TimeFormatError : in case of the timestamp not in timeformat array"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "pycharm": {
     "name": "#%%\n"
    }
   },
   "outputs": [],
   "source": [
    "def timestampTotimedate(timestamp, timeformats):\n",
    "    t=None\n",
    "    for timeformat in timeformats:\n",
    "        try:\n",
    "           t = datetime.strptime(timestamp, timeformat)\n",
    "        except ValueError:\n",
    "            pass\n",
    "    if t==None:\n",
    "        str=\"TimeFormatError : This timestamp don't match with formats in \"\n",
    "        for format in timeformats:\n",
    "            str+=format+\" \"\n",
    "        raise TimeFormatError(timestamp, str)\n",
    "    else:\n",
    "        return t"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "***TimeFormatError* class** to raise an error in case of the timestamp not in timeformat array "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "pycharm": {
     "name": "#%%\n"
    }
   },
   "outputs": [],
   "source": [
    "class Error(Exception):\n",
    "    \"\"\"Base class for exceptions in this module.\"\"\"\n",
    "    pass\n",
    "\n",
    "class TimeFormatError(Error):\n",
    "    \"\"\"Exception raised for errors in timeformat.\n",
    "\n",
    "    Attributes:\n",
    "        expression -- input expression in which the error occurred\n",
    "        message -- explanation of the error\n",
    "    \"\"\"\n",
    "\n",
    "    def __init__(self, expression, message):\n",
    "        self.expression = expression\n",
    "        self.message = message"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.6"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}