Merge lp:~manishsinha/cheers/insertion into lp:~cheers/cheers/trunk

[Manish Sinha (मनीष सिन्हा)]

Implemented the insertion of trophies and fixed the client python bindings

[lp:~manishsinha/cheers/insertion]

17. By Manish Sinha (मनीष सिन्हा) on 2010-10-27

Updated README, LICENSE, MAINTAINERS and fixed the name of the daemon file

=== modified file 'LICENSE'
--- LICENSE	2010-10-03 18:20:14 +0000
+++ LICENSE	2010-10-27 12:43:44 +0000
@@ -0,0 +1,21 @@
+# The MIT/X11/Expat License
+
+# Copyright (c) 2010 Manish Sinha<[e-mail]>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.

=== modified file 'MAINTAINERS'
--- MAINTAINERS	2010-10-03 18:20:14 +0000
+++ MAINTAINERS	2010-10-27 12:43:44 +0000
@@ -0,0 +1,1 @@
+Manish Sinha <[e-mail]>

=== modified file 'README'
--- README	2010-10-03 18:20:14 +0000
+++ README	2010-10-27 12:43:44 +0000
@@ -0,0 +1,38 @@
+Cheers is a trophya warding framework. It runs as a daemon activating a DBus Session bus over which applications can talk to it.
+
+It is written using python, sqlite, dbus
+
+Prerequisties
+---------------
+To get cheers up and running, you need the following packages. Please check your distribution for the exact name of the packages
+* python
+* python-dbus
+* python-sqlite
+* python-gio
+* python-glib
+* python-gtk
+
+
+
+Running
+---------
+Execute cheers-daemon using the command
+
+./cheers-daemon.py
+
+
+Registering a trophy
+---------------------
+
+Cheers keeps a watch on three folders for new trophies when the server is running. These two folders are
+* /usr/share/cheers/trophies
+* /usr/local/share/cheers/trophies
+* ~/.local/share/cheers/trophies
+
+A sample trophy aa.trophy is provided. Put it  under the folder ~/.local/share/cheers/trophies to register the trophy
+
+
+Debugging
+------------
+
+Use D-feet DBus debugger to have a look at the DBus API

=== added file 'aa.trophy'
--- aa.trophy	1970-01-01 00:00:00 +0000
+++ aa.trophy	2010-10-27 12:43:44 +0000
@@ -0,0 +1,1 @@
+{"id":"Name","setname":"Music", "seticon": "", "app":"application://banshee.desktop", "appname":"Banshee Music Player", "title":"FM Junkie", "iconpath":"", "priority": 1, "unlocked": "False", "stockicon":"", "desc": {"1": {"lang":"en-us", "desc": "Listen to Music alot"}, "2": {"lang":"en-uk", "desc": "Listen to Music a lot, a lot"}}}

=== added file 'cheers-daemon'
--- cheers-daemon	1970-01-01 00:00:00 +0000
+++ cheers-daemon	2010-10-27 12:43:44 +0000
@@ -0,0 +1,29 @@
+#! /usr/bin/env python
+
+# The MIT/X11/Expat License
+# Copyright (c) 2010 Manish Sinha<[e-mail]>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+from cheers import server
+
+if __name__ == "__main__":
+    
+    server.TrophyServer()

=== removed file 'cheers-daemon.py'
--- cheers-daemon.py	2010-10-17 20:31:25 +0000
+++ cheers-daemon.py	1970-01-01 00:00:00 +0000
@@ -1,27 +0,0 @@
-# The MIT/X11/Expat License
-# Copyright (c) 2010 Manish Sinha<[e-mail]>
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-
-from cheers import server
-
-
-if __name__ == "__main__":
-    cheers_server = server.TrophyServer()

=== modified file 'cheers/client.py'
--- cheers/client.py	2010-10-03 19:24:44 +0000
+++ cheers/client.py	2010-10-27 12:43:44 +0000
@@ -30,7 +30,7 @@
 
     def __init__(self):
         bus = dbus.SessionBus()
-        self.__interface = bus.get_object(OMG_BUS_NAME, OMG_OBJECT_PATH)
+        self.__interface = bus.get_object(CHEERS_BUS_NAME, CHEERS_OBJECT_PATH)
 
     def AwardTrophy(self, id, setname):
         """ Awards the trophy specified by it's id and the setName. 
@@ -39,23 +39,19 @@
         If the trophy has been registered, then it is awarded a small notify-osd(libnotify) notification is shown.
         If the trophy is not registered or has already been awarded, then nothing happens. Call GetTrophy(id,set) to check whether it trophy exists or has already been awarded.
         """
-        self.__interface.AwardTrophy(id, setname)
+        self.__interface.AwardTrophy(id)
 
     def DeleteTrophy(self, id, setname):
         """ Deletes the trophy permanently from the trophy store. 
         
         This is reverse of registering a trophy. This action is irreversible. Use with caution """
 
-        res = self.__interface.DeleteTrophy(id, setname)
-
-        return Response(res[0], res[1], res[2])
-
-    def UnAwardTrophy(self, id, setname):
+        self.__interface.DeleteTrophy(id)
+
+    def UnAwardTrophy(self, id):
         """ Do the reverse of awarding the trophy. Useful for debugging purposes """
     
-        res = self.__interface.UnAwardTrophy(id, setname)
-    
-        return Response(res[0], res[1], res[2])
+        self.__interface.UnAwardTrophy(id)
     
 
     def GetTrophies(self):
@@ -64,10 +60,10 @@
         trophy_list = self.__interface.GetTrophies()
         return [self.__UnwrapTrophy(trp) for trp in trophy_list]
 
-    def GetTrophy(self, id, setname):
+    def GetTrophy(self, id):
         """ Get a trophy given it's id and setname """
 
-        trophy = self.__interface.GetTrophy(str(id), str(setname))
+        trophy = self.__interface.GetTrophy(str(id))
         return self.__UnwrapTrophy(trophy)
 
     def GetTrophyBySet(self, setname):
@@ -82,7 +78,7 @@
         trophy_list = self.__interface.GetTrophyByApp(str(appname))
         return [self.__UnwrapTrophy(trp) for trp in trophy_list]
 
-    def GetTrophyById(self, id):
+    def GetTrophy(self, id):
         """ Get the trophie registered by it's ID"""
 
         trophy_list = self.__interface.GetTrophyById(str(id))
@@ -97,12 +93,15 @@
 
     def Quit(self):
         """ Exits the OMG Daemon """
-    
-        self.__interface.Quit()
+        try:
+            self.__interface.Quit()
+        except dbus.DBusException:
+            pass
 
     def __UnwrapTrophy(self, trophy):
         """ Unwraps the trophy instances as per the positions """
 
+        print(trophy)
         return Trophy(trophy[0], trophy [1], trophy [2], trophy [4], \
                         trophy[5], trophy[6], trophy[7], trophy[3], \
                         trophy[8], trophy[9], trophy[10], trophy[11])

=== modified file 'cheers/config.py'
--- cheers/config.py	2010-10-12 19:29:39 +0000
+++ cheers/config.py	2010-10-27 12:43:44 +0000
@@ -31,6 +31,7 @@
 
 trophy_dump_path = os.path.join(cheers_data_path, "trophies")
 global_trophy_path = "/usr/share/cheers/trophies"
+global_trophy_path_local = "/usr/local/share/cheers/trophies"
 
 DATA_STORE_TYPE = "sqlite"
 
@@ -47,10 +48,20 @@
 create_desc_command = "CREATE TABLE description (id TEXT, language TEXT, desc TEXT)"
 create_app_command = "CREATE TABLE app(appid INTEGER, app TEXT, appname TEXT)"
 create_set_command = "CREATE TABLE appset(setid INTEGER, setname TEXT, seticon TEXT)"
+create_history_command = "CREATE TABLE history(id TEXT, timestamp INTEGER)"
+
+insert_history_command = "INSERT INTO history VALUES(?,?)"
+insert_trophy_command = "INSERT INTO trophy VALUES(?,?,?,?,?,?,?,?,?)"
+insert_desc_command = "INSERT INTO description VALUES(?,?,?)"
+insert_app_command = "INSERT INTO app VALUES(?,?,?)"
+insert_set_command = "INSERT INTO appset VALUES(?,?,?)"
 
 fetch_trophy_where = "SELECT trophy.id, trophy.title, trophy.iconpath, app.app, app.appname, appset.setname, appset.seticon, trophy.priority, trophy.unlocked, trophy.timestamp, trophy.stockicon FROM trophy, app,appset WHERE trophy.app=app.appid and trophy.appset=appset.setid and %s=:value"
 fetch_trophy_all = "select trophy.id, trophy.title, trophy.iconpath, app.app, app.appname, appset.setname, appset.seticon, trophy.priority, trophy.unlocked, trophy.timestamp, trophy.stockicon FROM trophy, app,appset WHERE trophy.app=app.appid and trophy.appset=appset.setid"
 fetch_description = "SELECT language, desc FROM description WHERE id=:Id"
+fetch_history = "SELECT * FROM history WHERE id=?"
+fetch_set_byname = "SELECT * FROM appset WHERE setname=?"
+fetch_app_byapp = "SELECT * FROM app where app=?"
 
 award_trophy_command = "UPDATE trophy SET unlocked=1 WHERE id=?"
 unaward_trophy_command = "UPDATE trophy SET unlocked=0 WHERE id=?"

=== modified file 'cheers/datastore.py'
--- cheers/datastore.py	2010-10-12 19:29:39 +0000
+++ cheers/datastore.py	2010-10-27 12:43:44 +0000
@@ -22,6 +22,8 @@
 import os
 import sqlite3
 import config
+import random
+import datetime
 
 class SqliteStore():
     """ Implement the data storage based using sqlite as backend
@@ -46,27 +48,116 @@
         # Try creating the tables
         try:
             self.__cur.execute(config.create_trophy_command)
+        except sqlite3.OperationalError:
+            print("Trophy Table existed")
+        
+        try:
             self.__cur.execute(config.create_desc_command)
+        except sqlite3.OperationalError:
+            print("Description Table existed")
+        
+        try:
             self.__cur.execute(config.create_app_command)
+        except sqlite3.OperationalError:
+            print("App Table existed")
+        
+        try:
             self.__cur.execute(config.create_set_command)
-            print("All tables create successfully")
-        except sqlite3.OperationalError:
-            print("Table existed")
+        except sqlite3.OperationalError:
+            print("Set Table existed")
+            
+        try:
+            self.__cur.execute(config.create_history_command)
+        except sqlite3.OperationalError:
+            print("History Table existed")
+            
             
         self.__res_cursor=None
 
+    def AddTrophy(self, json_data):
+        """ Add the trophy to the database from the JSON data passed """
+        
+        res_history = self.__cur.execute(config.fetch_history, (json_data["id"],))
+        fetch_trp = config.fetch_trophy_where %("id",)
+        res_trophy = self.__cur.execute(fetch_trp, { "value":json_data["id"] })
+        if(len(res_history.fetchall()) == 0 and len(res_trophy.fetchall()) == 0):
+            
+            # Searching and Inserting Sets
+            set_list = self.__cur.execute(config.fetch_set_byname, (json_data["setname"],))
+            matched_set = set_list.fetchone()
+            if matched_set is None:
+                # Does not exist, create one
+                print("Set '%s' does not exist. Creating." %(json_data["setname"],))
+                setid = int(random.random()*10000000)
+                self.__cur.execute(config.insert_set_command, (setid, json_data["setname"], json_data["seticon"]))
+            else:
+                # Exists. Use it
+                print("Set '%s' already exists. Will be reused" %(matched_set[1],))
+                setid = matched_set[0]
+            
+            # Searching and Inserting Apps
+            app_list = self.__cur.execute(config.fetch_app_byapp, (json_data["app"],))
+            matched_app = app_list.fetchone()
+            if matched_app is None:
+                # Does not exist, create one
+                print("App '%s' does not exist. Creating." %(json_data["app"],))
+                appid = int(random.random()*10000000)
+                self.__cur.execute(config.insert_app_command, (appid, json_data["app"], json_data["appname"]))
+            else:
+                # Exists. Use it
+                print("App '%s' already exists. Will be reused" %(matched_app[1],))
+                appid = matched_app[0]
+            
+            
+            # Remove all description for this Id if present
+            desc_list = self.__cur.execute(config.remove_desc_command, (json_data["id"],))
+            # Inserting Description
+            desc_list = json_data["desc"]
+            for desc in desc_list.values():
+                self.__cur.execute(config.insert_desc_command, (json_data["id"], desc["lang"], desc["desc"]))
+            
+            timestamp = int(datetime.datetime(1970,01,01).today().strftime("%s"))
+             
+            try:    
+                # Inserting Trophy
+                is_present = self.Search("trophy.id", json_data["id"])
+                if len(is_present) > 0:
+                    print("The trophy '%s' already exists" %(json_data["id"], ))
+                else:            
+                    self.__cur.execute(config.insert_trophy_command, (  json_data["id"], \
+                                                                        json_data["title"], \
+                                                                        json_data["iconpath"], \
+                                                                        appid, \
+                                                                        setid, \
+                                                                        int(json_data["priority"]), \
+                                                                        bool(json_data["unlocked"]), \
+                                                                        timestamp, \
+                                                                        json_data["stockicon"]))
+                
+                # Inserting History
+                self.__cur.execute(config.insert_history_command, (json_data["id"], timestamp))
+                
+                self.__conn.commit()
+                pass
+            except:
+                raise
+            
+
     def AwardTrophy(self, id):
         """ Award the trophy """
+        
         self.__cur.execute(config.award_trophy_command, (id,))
         self.__conn.commit()
     
     def UnAwardTrophy(self, id):
         """ Un-Award the trophy """
+        
         self.__cur.execute(config.unaward_trophy_command, (id,))
         self.__conn.commit()
     
     def DeleteTrophy(self, id):
         """ Un-Award the trophy """
+        
         self.__cur.execute(config.remove_trophy_command, (id,))
         self.__cur.execute(config.remove_desc_command, (id,))
         self.__conn.commit()
@@ -94,6 +185,7 @@
 
         for val in self.__res_cursor:
             desc_cursor = self.__cur.execute(config.fetch_description, {"Id": val[0]})
+            print(desc_cursor)
             # Create the Localization Description
             desc_list = [[desc[0], desc[1]] for desc in desc_cursor]
             
@@ -102,13 +194,13 @@
             
             trophy_list.append(trp)
         
-        print(trophy_list)
         return trophy_list
     
     def _CreateTrophyDBus(self, desc_list, trp):
         """ Create the DBus representation of Trophy which is to be sent
         over DBus matching the signature a(ssaasssssisbxs) 
         """
+        
         if trp[8] == 0:
             unlocked = 0
         else:

=== modified file 'cheers/server.py'
--- cheers/server.py	2010-10-17 20:31:25 +0000
+++ cheers/server.py	2010-10-27 12:43:44 +0000
@@ -63,15 +63,20 @@
             global_monitor = global_dump.monitor_directory(gio.FILE_MONITOR_NONE, None)
             global_monitor.connect("changed", self.directory_changed)
         
+        if os.path.exists(config.global_trophy_path_local):
+            global_dump_local = gio.File(config.global_trophy_path_local)
+            global_monitor_local = global_dump_local.monitor_directory(gio.FILE_MONITOR_NONE, None)
+            global_monitor_local.connect("changed", self.directory_changed)
+        
         # Start the MainLoop
         glib.MainLoop().run()
         
     def directory_changed(self, monitor, file1, file2, evt_type):
         """ The callback for handling the directory changes notification """
         
-       if (evt_type in (gio.FILE_MONITOR_EVENT_CREATED,)):
-           print "Changed:", file1, file2, evt_type
-           self.AddTrophy(file1.get_path())
+        if (evt_type in (gio.FILE_MONITOR_EVENT_CREATED,)):
+            print "Changed:", file1, file2, evt_type
+            self.AddTrophy(file1.get_path())
        
     def AddTrophy(self, trophy_file):
         """ Read the JSON trophy files and register it """
@@ -81,6 +86,7 @@
         json_data = json.load(fs)
         fs.close()
 
+        self.__store.AddTrophy(json_data)
 
     @dbus.service.method(config.CHEERS_BUS_NAME, in_signature='s')
     def DeleteTrophy(self, id):
@@ -135,8 +141,8 @@
     
     
     
-    @dbus.service.method(config.CHEERS_BUS_NAME, in_signature='ss')
-    def UnAwardTrophy(self, id, setname):
+    @dbus.service.method(config.CHEERS_BUS_NAME, in_signature='s')
+    def UnAwardTrophy(self, id):
         """ Find the trophy to be unawarded, unaward it and send a async reply via event """
         
         trophies = self.__store.Search("trophy.id", id)