Last modifications before releasing survey.

Tássia Camões Araújo
1 parent dabda648
Showing 7 changed files with 126 additions and 117 deletions Show diff stats
src/web/static/css/survey.css
src/web/survey.py
src/web/templates/index_survey.html
src/web/templates/layout.html
src/web/templates/survey.html
src/web/templates/thanks.html
src/web/templates/thanks_id.html
@@ -97,6 +97,7 @@ margin-bottom: 10px;
 }
 .radioButton,
+#start-button,
 #next-button,
 #restart-button,
 #continue-button,
@@ -148,7 +149,7 @@ cursor: pointer;
 #panel-controls {
 position: relative; 
 width: 200px;
-height: 60px;
+height: 80px;
 padding: 5px;
 margin: 5px;
 border-radius: 5px;
@@ -12,6 +12,7 @@ import urllib
 import socket
 import csv
 import datetime
+import stat
 sys.path.insert(0,"/var/www/AppRecommender/src/")
@@ -38,15 +39,16 @@ class Thanks:
         user_id = web_input['user_id'].encode('utf8')
         personal_file = open("/var/www/AppRecommender/src/web/submissions/%s/personal" % user_id,'w')
         personal = {}
-        for key in ["name","email","comments"]:
+        for key in ["name","email","user_habits","comments"]:
             if web_input.has_key(key):
                 personal[key] = web_input[key].encode("utf-8")
             else:
                 personal[key] = ""
         try:
             writer = csv.writer(personal_file)
-            writer.writerow(("user","name","email","comments"))
-            writer.writerow((user_id,personal["name"],personal["email"],personal["comments"]))
+            writer.writerow(("user","name","email","habits_id","comments"))
+            writer.writerow((user_id,personal["name"],personal["email"],
+                             personal["user_habits"],personal["comments"]))
         except:
             error_msg = "Could not save optional information."
             logging.critical("Could not save optional information.")
@@ -72,7 +74,8 @@ class Save:
                       % (user_id,strategy))
         summary = {}
         summary["poor"] = 0
-        summary["good"] = 0
+        summary["redundant"] = 0
+        summary["useful"] = 0
         summary["surprising"] = 0
         # Save evaluation
@@ -94,44 +97,42 @@ class Save:
                             summary[evaluation] += 1
                             break
                     prediction_file.seek(0)
+            prediction_file.close()
+            evaluation_file.close()
         except:
             error_msg = "Could not write evaluation to file."
             logging.critical(error_msg)
             return render.error([error_msg], "/survey/","START")
         finally:
-            prediction_file.close()
-            evaluation_file.close()
             os.remove(os.path.join(strategy_dir,"prediction"))
             with open(os.path.join(strategy_dir,"end"),'w') as end:
                 end_time = datetime.datetime.now().strftime("%Y%m%d%H%M%S")
                 end.write(end_time)
         # Save report
-        try:
-            report = os.path.join(user_dir,"report")
-            report_file = open(os.path.join(user_dir,"report"),'a')
-            writer = csv.writer(report_file)
-            if os.path.getsize(report) == 0:
-                fieldnames = ('user','strategy',"start","end",'truepositive',
-                              'falsepositive','surprise','comments')
-                writer.writerow(fieldnames)
-            with open(os.path.join(strategy_dir,"start"),'r') as start:
-                start_time = start.readline().strip()
-            if web_input.has_key("comments"):
-                comments =  web_input['comments'].encode("utf-8")
-            else:
-                comments = ""
-            writer.writerow((user_id,strategy,start_time,end_time,
-                             summary["good"]+summary["surprising"],
-                             summary["poor"],summary["surprising"],comments))
-        except:
-            if comments:
-                error_msg = "Could not save comments."
-                logging.critical(error_msg)
-                return render.error([error_msg], "/survey/","START")
-            logging.critical("Could not save evaluation report.")
-        finally:
-            report_file.close()
+        #try:
+        report = os.path.join(user_dir,"report")
+        report_file = open(os.path.join(user_dir,"report"),'a')
+        writer = csv.writer(report_file)
+        if os.path.getsize(report) == 0:
+            fieldnames = ('user','strategy','start','end','poor',
+                          'redundant','useful','surprising','comments')
+            writer.writerow(fieldnames)
+        with open(os.path.join(strategy_dir,"start"),'r') as start:
+            start_time = start.readline().strip()
+        if web_input.has_key("comments"):
+            comments =  web_input['comments'].encode("utf-8")
+        else:
+            comments = ""
+        writer.writerow((user_id,strategy,start_time,end_time,summary["poor"],
+                         summary["redundant"],summary["useful"],
+                         summary["surprising"],comments))
+        #except:
+        #    error_msg = "Could not save evaluation report."
+        #    logging.critical(error_msg)
+        #    return render.error([error_msg], "/survey/","START")
+        #finally:
+        #    report_file.close()
         if web_input.has_key('continue_button'):
             return Survey().POST()
@@ -140,42 +141,26 @@ class Save:
         else:
             return render.index_survey()
-class Request:
-    def __init__(self,web_input,submissions_dir):
-        self.strategy = ""
-        # Check if it is first round
-        if web_input.has_key('user_id'):
-            self.user_id = web_input['user_id'].encode('utf8')
-            self.user_dir = os.path.join(submissions_dir, self.user_id)
-            logging.info("New round for user %s" % self.user_id)
-        else:
-            self.user_dir = tempfile.mkdtemp(prefix='',dir=submissions_dir)
-            self.user_id = self.user_dir.split("/")[-1]
-            logging.info("Request from user %s" % self.user_id)
-            logging.debug("Created dir %s" % self.user_dir)
-        uploaded_file = os.path.join(self.user_dir,"uploaded_file")
+class Instruction:
+    def POST(self):
+        web_input = web.input(pkgs_file={})
+        submissions_dir = "/var/www/AppRecommender/src/web/submissions/"
+        user_dir = tempfile.mkdtemp(prefix='',dir=submissions_dir)
+        os.chmod(user_dir,stat.S_IRWXU|stat.S_IXOTH|stat.S_IROTH)
+        user_id = user_dir.split("/")[-1]
+        logging.info("Request from user %s" % user_id)
+        logging.debug("Created dir %s" % user_dir)
+        uploaded_file = os.path.join(user_dir,"uploaded_file")
         if not os.path.exists(uploaded_file):
             if web_input['pkgs_file'].value:
                 lines = web_input['pkgs_file'].file.readlines()
                 with open(uploaded_file, "w") as uploaded:
                     uploaded.writelines(lines)
-        with open(uploaded_file) as uploaded:
-            if uploaded.readline().startswith('POPULARITY-CONTEST'):
-                self.user = PopconSystem(uploaded_file,self.user_id)
             else:
-                self.user = PkgsListSystem(uploaded_file,self.user_id)
-
-    def __str__(self):
-        return "Request %s:\n %s" % (self.user.user_id,
-                                     str(self.user.pkg_profile))
-
-    def validates(self):
-        self.errors = []
-        if not self.user.pkg_profile:
-            self.errors.append("No packages list provided.")
-        if self.errors:
-            return False
-        return True
+                # saving empty files
+                with open(uploaded_file, "w") as uploaded:
+                    pass
+        return render.intro(user_id)
 class Survey:
     def __init__(self):
@@ -185,24 +170,46 @@ class Survey:
         self.submissions_dir = "/var/www/AppRecommender/src/web/submissions/"
         if not os.path.exists(self.submissions_dir):
             os.makedirs(self.submissions_dir)
-
+        self.strategies = ["cbh","cbh_eset",
+                           "knn","knn_eset","knn_plus",
+                           "knnco"]
     def POST(self):
         web_input = web.input(pkgs_file={})
-        logging.debug("Survey web_input %s" % str(web_input))
-        self.strategies = ["cb","cbh","cb_eset","cbh_eset",
-                           "knn","knn_eset","knn_plus",
-                           "knnco","knnco_eset"]
-        request = Request(web_input,self.submissions_dir)
-        if len(request.user.pkg_profile)<10:
+        if web_input.has_key('user_id'):
+            user_id = web_input['user_id'].encode('utf8')
+            user_dir = os.path.join(self.submissions_dir, user_id)
+            logging.info("New recommendation for user %s" % user_id)
+        
+        uploaded_file = os.path.join(user_dir,"uploaded_file")
+        with open(uploaded_file) as uploaded:
+            if uploaded.readline().startswith('POPULARITY-CONTEST'):
+                user = PopconSystem(uploaded_file,user_id)
+            else:
+                user = PkgsListSystem(uploaded_file,user_id)
+        user.maximal_pkg_profile()
+        if len(user.pkg_profile)<10:
             error_msg = "Could not extract profile from uploaded file. It must have at least 10 applications."
             logging.critical(error_msg)
             return render.error([error_msg], "/survey/","START")
         else:
-            request.strategy = self.set_rec_strategy(request.user_id)
-            prediction = self.rec.get_recommendation(request.user,10).get_prediction()
-            logging.info("Prediction for user %s" % request.user_id)
+            # Check the remaining strategies and select a new one
+            old_strategies = [dirs for root, dirs, files in
+                              os.walk(os.path.join(self.submissions_dir,
+                                                   user_id))]
+            if old_strategies:
+                strategies = [s for s in self.strategies if s not in old_strategies[0]]
+                logging.info("Already used strategies %s" % old_strategies[0])
+            else:
+                strategies = self.strategies
+            if not strategies:
+                return render.thanks(user_id)
+            selected_strategy = random.choice(strategies)
+            logging.info("Selected \'%s\' from %s" % (selected_strategy,strategies))
+            self.set_rec_strategy(selected_strategy)
+            prediction = self.rec.get_recommendation(user,10).get_prediction()
+            logging.info("Prediction for user %s" % user_id)
             logging.info(str(prediction))
-            self.save_prediction(request,prediction)
+            self.save_prediction(user_id,selected_strategy,prediction)
             # Load packages details
             recommendation = [result[0] for result in prediction]
@@ -215,32 +222,15 @@ class Survey:
             if pkgs_details:
                 logging.info("Rendering survey slide...")
-                return render.survey(pkgs_details, request)
+                return render.survey(pkgs_details, user_id, selected_strategy, len(strategies))
             else:
                 return render.error(["No recommendation produced for the uploaded file."],"/survey/","START")
-    def set_rec_strategy(self,user_id):
-        # Check the remaining strategies and select a new one
-        old_strategies = [dirs for root, dirs, files in
-                          os.walk(os.path.join(self.submissions_dir,
-                                               user_id))]
-        if old_strategies:
-            strategies = [s for s in self.strategies if s not in old_strategies[0]]
-            logging.info("Already used strategies %s" % old_strategies[0])
-        else:
-            strategies = self.strategies
-        if not strategies:
-            return render.thanks(request.user_id)
-        selected_strategy = random.choice(strategies)
-        logging.info("Selected \'%s\' from %s" % (selected_strategy,strategies))
-        k=50
-        n=50
-        if selected_strategy == "cb":
-            pass
+    def set_rec_strategy(self,selected_strategy):
+        k=10
+        n=20
         if selected_strategy == "cbh":
             pass
-        if selected_strategy == "cb_eset":
-            pass
         if selected_strategy == "cbh_eset":
             pass
         if selected_strategy == "knn":
@@ -251,13 +241,11 @@ class Survey:
             pass
         if selected_strategy == "knnco":
             pass
-        if selected_strategy == "knnco_eset":
-            pass
         self.rec.set_strategy(selected_strategy,k,n)
         return selected_strategy
-    def save_prediction(self,request,prediction):
-        strategy_dir = os.path.join(request.user_dir,request.strategy)
+    def save_prediction(self,user_id,strategy,prediction):
+        strategy_dir = os.path.join(self.submissions_dir,user_id,strategy)
         if not os.path.exists(strategy_dir):
             os.makedirs(strategy_dir)
         ranking = 0
@@ -279,7 +267,7 @@ class Survey:
             now = datetime.datetime.now()
             start.write(now.strftime("%Y%m%d%H%M%S"))
         logging.debug("Saved prediction to file at %s/%s" %
-                      (request.user_id,request.strategy))
+                      (user_id,strategy))
 #def add_global_hook():
 #    g = web.storage({"counter": "1"})
 #    def _wrapper(handler):
@@ -290,7 +278,8 @@ class Survey:
 render = web.template.render('/var/www/AppRecommender/src/web/templates/', base='layout', globals={'hasattr':hasattr})
 render_plain = web.template.render('/var/www/AppRecommender/src/web/templates/', globals={'hasattr':hasattr})
-urls = ('/apprec',         'Survey',
+urls = ('/apprec',         'Instruction',
+        '/evaluation',     'Survey',
         '/thanks',   	   'Thanks',
         '/save',   	   'Save',
         '/about',          'About',
@@ -23,7 +23,7 @@ window.onload = function() {
 <a href="http://github.com/tassia/AppRecommender">AppRecommender</a>,
 a recommender system for GNU/Linux applications.</p><br />
   <p align="justify"> Given a list of packages installed in a real
-  running system and a set of applications will be suggested for it. 
+  running system, a set of applications will be suggested for it. 
   Upload a popularity-contest submission file (usually located at
   '/var/log/popularity-contest') or run the following command and
   upload the generated 'packages.list' file.</p><br />
@@ -80,7 +80,7 @@ function validateForm()
     <div id="upload-slide">
 	 <fieldset>
 	<p>
-	   <label title="Upload file">Installed packages file: <input type="file" name="pkgs_file" size="20" /></label>
+	   <label title="Upload file">Installed packages: <input type="file" name="pkgs_file" size="20" /></label>
 	</p>
 	<div id="tip-upload" class="tip important">
 	<p>
-$def with (pkgs_details, request)
+$def with (pkgs_details, user_id, strategy, remaining)
 $var title: Survey
 $var url_base: /survey/
 $var action: START
@@ -28,16 +28,20 @@ $var jsfiles: /static/coda-slider-2.0/javascripts/jquery-1.3.2.min.js /static/co
 <div class="show-end" style="display: none;">
-<p>
-If you have any comment regarding this set of suggestions, please write in the form below. Choose <i>Continue</i> if you can perform another round of evaluations, or <i>Finish</i> to conclude your participation.
+<p align="justify">
+If you have any comments regarding this set of suggestions, please write in the
+form below. There are <b>$(remaining-1) remaining</b> recommendation strategies to be evaluated.
+Choose <i>Continue</i> if you can perform one more round of evaluations, or
+<i>Finish</i> to conclude your participation.
 </p>
 </div>
 <form action="save" method="post" enctype="multipart/form-data" name="surveyform">
-<input type="hidden" name="user_id" value=$request.user.user_id>
-<input type="hidden" name="strategy" value=$request.strategy>
+<input type="hidden" name="user_id" value=$user_id>
+<input type="hidden" name="strategy" value=$strategy>
+<input type="hidden" name="remaining" value=$remaining>
 <div style="display: none; width: 400px; margin-left: 150px; margin-top: 10px;" class="show-end"><!-- display show in the end form -->
 <p align="center">
@@ -62,16 +66,20 @@ $for pkg in pkgs_details:
 		     	<div id="panel-controls" class="glass">
 		   <fieldset>
 			<label class="radioButton">
-			<input class="radio" type="radio" name="evaluation-$pkgs_details.index(pkg)" value="surprising" />
-			Pleasantly surprising
+			<input class="radio" type="radio" name="evaluation-$(pkgs_details.index(pkg))" value="poor" />
+			Poor
+			</label><br />
+			<label class="radioButton">
+			<input class="radio" type="radio" name="evaluation-$(pkgs_details.index(pkg))" value="redundant" />
+			Redundant
 			</label><br />
        			<label class="radioButton">
-			<input class="radio yesb" type="radio" name="evaluation-$pkgs_details.index(pkg)" value="good" />
+			<input class="radio" type="radio" name="evaluation-$pkgs_details.index(pkg)" value="useful" />
 			Useful
 			</label><br />
 			<label class="radioButton">
-			<input class="radio" type="radio" name="evaluation-$(pkgs_details.index(pkg))" value="poor" />
-			Poor
+			<input class="radio" type="radio" name="evaluation-$pkgs_details.index(pkg)" value="surprising" />
+			Pleasantly surprising
 			</label>
 		   </fieldset>
 			<br style="clear: both;" />
@@ -14,14 +14,25 @@ $var cssfiles: static/css/survey.css
 <div class="innertube">
 <h1>AppRecommender Survey</h1>
-<p>Thank you very much for participating in this survey, you help is very much
-appreciated! Identify yourself if you want to be mentioned in our thanks page
-and final report.
-</p><br />
+<p>Thank you very much for participating in this survey!</p>
+<p>Last but not least, we'd like to have your personal identification to mention
+your name in our thanks page. The awareness of your installation habits would
+make our report more informative and, finally, we appreciate general comments
+regarding this survey and/or the recommendations you got.</p>
 <div style="margin-left:150px;" id="optionalform">
 <center>
 <form action="thanks" method="post" enctype="multipart/form-data" name="identification_form">
+<div style="text-align: left;">
+  <p><label style="margin-left: 7px">Admin's habit</label>
+  <fieldset style="margin-left: 20px">
+    <input type=radio class=radio name="user_habits" value="1">I rarely install new applications.<br />
+    <input type=radio class=radio name="user_habits" value="2">I only install when I get a trusted recommendation.<br />
+    <input type=radio class=radio name="user_habits" value="3">I actively seek for new applications.<br />
+    <input type=radio class=radio name="user_habits" value="0">I would rather not comment on that.<br />
+  </fieldset>
+  </p>
+</div>
   <p>
   <label>
   <input type="hidden" name="user_id" value=$user_id>
@@ -10,7 +10,7 @@ $var cssfiles: static/css/survey.css
 <center>
 <h1>Thanks!</h1>
-<p>Thank you once again and stay tuned for the survey report.</p><br />
+<p>Thank you once again, your help is very much appreciated!</p><br />
 </center>
 </div><!-- class="innertube" -->
	@@ -23,7 +23,7 @@ window.onload = function() {		@@ -23,7 +23,7 @@ window.onload = function() {
23	<a href="http://github.com/tassia/AppRecommender">AppRecommender</a>,	23	<a href="http://github.com/tassia/AppRecommender">AppRecommender</a>,
24	a recommender system for GNU/Linux applications.</p><br />	24	a recommender system for GNU/Linux applications.</p><br />
25	<p align="justify"> Given a list of packages installed in a real	25	<p align="justify"> Given a list of packages installed in a real
26	- running system and a set of applications will be suggested for it.	26	+ running system, a set of applications will be suggested for it.
27	Upload a popularity-contest submission file (usually located at	27	Upload a popularity-contest submission file (usually located at
28	'/var/log/popularity-contest') or run the following command and	28	'/var/log/popularity-contest') or run the following command and
29	upload the generated 'packages.list' file.</p><br />	29	upload the generated 'packages.list' file.</p><br />
	@@ -80,7 +80,7 @@ function validateForm()		@@ -80,7 +80,7 @@ function validateForm()
80	<div id="upload-slide">	80	<div id="upload-slide">
81	<fieldset>	81	<fieldset>
82	<p>	82	<p>
83	- <label title="Upload file">Installed packages file: <input type="file" name="pkgs_file" size="20" /></label>	83	+ <label title="Upload file">Installed packages: <input type="file" name="pkgs_file" size="20" /></label>
84	</p>	84	</p>
85	<div id="tip-upload" class="tip important">	85	<div id="tip-upload" class="tip important">
86	<p>	86	<p>
	@@ -14,14 +14,25 @@ $var cssfiles: static/css/survey.css		@@ -14,14 +14,25 @@ $var cssfiles: static/css/survey.css
14	<div class="innertube">	14	<div class="innertube">
15		15
16	<h1>AppRecommender Survey</h1>	16	<h1>AppRecommender Survey</h1>
17	-<p>Thank you very much for participating in this survey, you help is very much
18	-appreciated! Identify yourself if you want to be mentioned in our thanks page
19	-and final report.
20	-</p><br />	17	+<p>Thank you very much for participating in this survey!</p>
		18	+<p>Last but not least, we'd like to have your personal identification to mention
		19	+your name in our thanks page. The awareness of your installation habits would
		20	+make our report more informative and, finally, we appreciate general comments
		21	+regarding this survey and/or the recommendations you got.</p>
21		22
22	<div style="margin-left:150px;" id="optionalform">	23	<div style="margin-left:150px;" id="optionalform">
23	<center>	24	<center>
24	<form action="thanks" method="post" enctype="multipart/form-data" name="identification_form">	25	<form action="thanks" method="post" enctype="multipart/form-data" name="identification_form">
		26	+<div style="text-align: left;">
		27	+ <p><label style="margin-left: 7px">Admin's habit</label>
		28	+ <fieldset style="margin-left: 20px">
		29	+ <input type=radio class=radio name="user_habits" value="1">I rarely install new applications.<br />
		30	+ <input type=radio class=radio name="user_habits" value="2">I only install when I get a trusted recommendation.<br />
		31	+ <input type=radio class=radio name="user_habits" value="3">I actively seek for new applications.<br />
		32	+ <input type=radio class=radio name="user_habits" value="0">I would rather not comment on that.<br />
		33	+ </fieldset>
		34	+ </p>
		35	+</div>
25	<p>	36	<p>
26	<label>	37	<label>
27	<input type="hidden" name="user_id" value=$user_id>	38	<input type="hidden" name="user_id" value=$user_id>
	@@ -10,7 +10,7 @@ $var cssfiles: static/css/survey.css		@@ -10,7 +10,7 @@ $var cssfiles: static/css/survey.css
10		10
11	<center>	11	<center>
12	<h1>Thanks!</h1>	12	<h1>Thanks!</h1>
13	-<p>Thank you once again and stay tuned for the survey report.</p><br />	13	+<p>Thank you once again, your help is very much appreciated!</p><br />
14	</center>	14	</center>
15		15
16	</div><!-- class="innertube" -->	16	</div><!-- class="innertube" -->