Merge lp:~aaronp/software-center/enhance-usefulness into lp:software-center

[Aaron Peachey]

enhance usefulness functionality to add support for getting user's votes from the server at startup and anytime we get the username of the user

- fix bug that causes crash when submitting usefulness because unused usefulness UI doesn't contain all elements that need to be updated since adding the error details expander (r1755)
- add support for getting user's votes from server by first loading them from local cache and then spawning a retrieval process in the background to populate them from the server once a response is received. Load from cache whenever UsefulnessCache object is created except upon startup (app.py) when we try to get them from the server (r1756-1758)
- don't update username into local config if the one we have is the same as the one we want to update. (r1759)
- if we DO update a new username into local config, try to update the UsefulnessCache from the server using the new username (as it's likely we didn't get it from the server at startup) (r1759)

=== added symlink 'data/get_useful_votes_helper.py'
=== target is u'../utils/get_useful_votes_helper.py'
=== modified file 'softwarecenter/app.py'
--- softwarecenter/app.py	2011-04-29 14:38:29 +0000
+++ softwarecenter/app.py	2011-05-01 07:52:26 +0000
@@ -61,7 +61,7 @@
 from paths import SOFTWARE_CENTER_ICON_CACHE_DIR
 
 from plugin import PluginManager
-from db.reviews import get_review_loader
+from db.reviews import get_review_loader, UsefulnessCache
 from distro import get_distro
 from apt.aptcache import AptCache
 from gettext import gettext as _
@@ -169,6 +169,8 @@
         self.review_loader = get_review_loader(self.cache, self.db)
         # FIXME: add some kind of throttle, I-M-S here
         self.review_loader.refresh_review_stats(self.on_review_stats_loaded)
+        #load usefulness votes from server when app starts
+        self.useful_cache = UsefulnessCache(True)
     
         # additional icons come from app-install-data
         self.icons = gtk.icon_theme_get_default()

=== modified file 'softwarecenter/db/reviews.py'
--- softwarecenter/db/reviews.py	2011-04-29 14:28:01 +0000
+++ softwarecenter/db/reviews.py	2011-05-01 07:52:26 +0000
@@ -59,16 +59,72 @@
 
     USEFULNESS_CACHE = {}
     
-    def __init__(self):
+    def __init__(self, try_server=False):
+        self.rnrclient = RatingsAndReviewsAPI()
         fname = "usefulness.p"
         self.USEFULNESS_CACHE_FILE = os.path.join(SOFTWARE_CENTER_CACHE_DIR,
                                                     fname)
+        
+        self._retrieve_votes_from_cache()
+        #Only try to get votes from the server if required, otherwise just use cache
+        if try_server:
+            self._retrieve_votes_from_server()
+    
+    def _retrieve_votes_from_cache(self):
         if os.path.exists(self.USEFULNESS_CACHE_FILE):
             try:
                 self.USEFULNESS_CACHE = cPickle.load(open(self.USEFULNESS_CACHE_FILE))
             except:
-                LOG.exception("usefulness cache load failure")
+                LOG.exception("usefulness cache load fallback failure")
                 os.rename(self.USEFULNESS_CACHE_FILE, self.USEFULNESS_CACHE_FILE+".fail")
+        return
+    
+    def _retrieve_votes_from_server(self):
+        LOG.debug("_retrieve_votes_from_server started")
+        user = get_person_from_config()
+        
+        if not user:
+            LOG.warn("Could not get usefulness from server, no username in config file")
+            return False
+        
+        # run the command and add watcher
+        cmd = [os.path.join(softwarecenter.paths.datadir, GET_USEFUL_VOTES_HELPER),
+               "--username", user, 
+              ]
+        try:
+            (pid, stdin, stdout, stderr) = glib.spawn_async(
+                cmd, flags = glib.SPAWN_DO_NOT_REAP_CHILD, 
+                standard_output=True, standard_error=True)
+            glib.child_watch_add(pid, self._usefulness_loaded, data=(stdout, stderr))
+            return True
+        except Exception as e:
+            LOG.warn("failed to launch: '%s' (error: '%s')" % (cmd, e))
+            return False
+
+    def _usefulness_loaded(self, pid, status, (stdout, stderr)):
+        '''called if usefulness retrieved from server'''
+        LOG.debug("_usefulness_loaded started")
+        # get status code
+        res = os.WEXITSTATUS(status)
+        # check stderr
+        err = os.read(stderr, 4*1024)
+        if err:
+            LOG.warn("got error from helper: '%s'" % err)
+        os.close(stderr)
+        # read the raw data
+        data = ""
+        while True:
+            s = os.read(stdout, 1024)
+            if not s: break
+            data += s
+        os.close(stdout)
+
+        results = cPickle.loads(data)
+        self.USEFULNESS_CACHE.clear()
+        for result in results:
+            self.USEFULNESS_CACHE[str(result['review_id'])] = result['useful']
+        if not self.save_usefulness_cache_file():
+            LOG.warn("Read usefulness results from server but failed to write to cache")
     
     def save_usefulness_cache_file(self):
         """write the dict out to cache file"""

=== modified file 'softwarecenter/paths.py'
--- softwarecenter/paths.py	2011-04-19 18:21:55 +0000
+++ softwarecenter/paths.py	2011-05-01 07:52:26 +0000
@@ -58,6 +58,7 @@
 SUBMIT_USEFULNESS_APP = "submit_usefulness.py"
 GET_REVIEWS_HELPER = "get_reviews_helper.py"
 GET_REVIEW_STATS_HELPER = "get_review_stats_helper.py"
+GET_USEFUL_VOTES_HELPER = "get_useful_votes_helper.py"
 
 # there was a bug in maverick 3.0.3 (#652151) that could lead to a empty
 # root owned directory in ~/.cache/software-center - we remove it here

=== modified file 'softwarecenter/utils.py'
--- softwarecenter/utils.py	2011-04-28 12:32:58 +0000
+++ softwarecenter/utils.py	2011-05-01 07:52:26 +0000
@@ -379,11 +379,16 @@
     """
     # FIXME: ideally this would be stored in ubuntu-sso-client
     #        but it dosn't so we store it here
-    config = get_config()
-    if not config.has_section("reviews"):
-        config.add_section("reviews")
-    config.set("reviews", "username", username)
-    config.write()
+    curr_name = get_person_from_config()
+    if curr_name != username:
+        config = get_config()
+        if not config.has_section("reviews"):
+            config.add_section("reviews")
+        config.set("reviews", "username", username)
+        config.write()
+        from db.reviews import UsefulnessCache
+        usefulness = UsefulnessCache(True)
+    return
             
 def get_person_from_config():
     """ get the username value for Ubuntu SSO from the config file

=== added file 'utils/get_useful_votes_helper.py'
--- utils/get_useful_votes_helper.py	1970-01-01 00:00:00 +0000
+++ utils/get_useful_votes_helper.py	2011-05-01 07:52:26 +0000
@@ -0,0 +1,45 @@
+#!/usr/bin/python
+
+import pickle
+import simplejson
+import logging
+
+from optparse import OptionParser
+from softwarecenter.backend.rnrclient import RatingsAndReviewsAPI
+from piston_mini_client import APIError
+
+LOG = logging.getLogger(__name__)
+
+if __name__ == "__main__":
+    logging.basicConfig()
+
+    # common options for optparse go here
+    parser = OptionParser()
+
+    # check options
+    parser.add_option("--username", default=None)
+    (options, args) = parser.parse_args()
+
+    rnrclient = RatingsAndReviewsAPI()
+            
+    useful_votes = []
+    
+    if options.username:
+        try:
+            useful_votes = rnrclient.get_usefulness(username=options.username)
+        except simplejson.decoder.JSONDecodeError, e:
+            LOG.error("failed to parse '%s'" % e.doc)
+        except APIError, e:
+            LOG.warn("_get_useful_votes_helper: no usefulness able to be retrieved for username: %s" % (options.username))
+            LOG.debug("_get_reviews_threaded: no reviews able to be retrieved: %s" % e)
+        except:
+            LOG.exception("_get_useful_votes_helper")
+
+    # print to stdout where its consumed by the parent
+    try:
+        print pickle.dumps(useful_votes)
+    except IOError:
+        # this can happen if the parent gets killed, no need to trigger
+        # apport for this
+        pass
+

=== modified file 'utils/submit_review.py'
--- utils/submit_review.py	2011-04-29 15:00:11 +0000
+++ utils/submit_review.py	2011-05-01 07:52:26 +0000
@@ -1105,6 +1105,14 @@
     def run(self):
         self.login()
     
+    # override UI update methods from BaseApp to prevent them 
+    # causing errors if called when UI is hidden
+    def _clear_status_imagery(self):
+        pass
+    
+    def _change_status(self, type, message):
+        pass
+    
 
 if __name__ == "__main__":