Merge pull request #422 from MipsaPatel/recommendations-page

raj454raj · web-flow · commit 7f34d1194b50 · 2020-09-12T11:58:00.000+05:30
Added problem recommendations feature
diff --git a/controllers/problems.py b/controllers/problems.py
@@ -95,6 +95,7 @@ def by():
 
     return_val["table"] = utilities.get_problems_table(problems,
                                                        session.user_id,
+                                                       "problems-authored",
                                                        None)
 
     return_val["problems_count"] = len(problems)
@@ -870,6 +871,7 @@ def search():
 
     return dict(table=utilities.get_problems_table(all_problems,
                                                    session.user_id,
+                                                   "problem-search",
                                                    problem_with_user_editorials),
                 generalized_tags=generalized_tags)
 
@@ -931,4 +933,56 @@ def trending():
 
     return dict(div=div)
 
+# ----------------------------------------------------------------------------
+@auth.requires_login()
+def recommendations():
+    """
+        Problem recommendations for the user.
+    """
+    import recommendations.problems as recommendations
+
+    ptable = db.problem
+    rtable = db.problem_recommendations
+    user_id = session.user_id
+    refresh = request.vars.get("refresh", "false") == "true"
+
+    output = {}
+    recommendation_pids = []
+
+    rows = db(rtable.user_id == user_id).select()
+    if len(rows) == 0:
+        refresh = True
+
+    if refresh:
+        recommendation_pids = recommendations.generate_recommendations(user_id)
+    else:
+        recommendation_pids, _ = recommendations.retrieve_past_recommendations(user_id)
+
+    if len(recommendation_pids) > 0:
+        problem_details = db(ptable.id.belongs(recommendation_pids)).select()
+        output["table"] = utilities.get_problems_table(problem_details,
+                                                       user_id,
+                                                       "recommendation",
+                                                       None)
+    else:
+        output["table"] = "No recommendations available."
+
+    query = (rtable.user_id == user_id) & (rtable.is_active == True)
+    rows = db(query).select(rtable.generated_at)
+
+    output["can_update"] = True
+    if len(rows) > 0:
+        output["can_update"] = (datetime.datetime.now().date() - rows[0].generated_at).days \
+            >= RECOMMENDATION_REFRESH_INTERVAL
+
+    return output
+
+# ----------------------------------------------------------------------------
+@auth.requires_login()
+def update_recommendation_status():
+    from recommendations.problems import update_recommendation_status
+
+    pid = long(request.args[0])
+    update_recommendation_status(session.user_id, pid)
+
 # ==============================================================================
diff --git a/deploy_scripts/STATIC_FILES b/deploy_scripts/STATIC_FILES
@@ -1 +1,2 @@
-js/appjs/problems/index.js
+js/appjs/problems/recommendations.js
+js/appjs/google_analytics.js
diff --git a/deploy_scripts/static_files_list.txt b/deploy_scripts/static_files_list.txt
@@ -28,6 +28,7 @@ js/appjs/user/submissions.js
 js/appjs/user/profile.js
 js/appjs/default/user_editorials.js
 js/appjs/default/user_wise_editorials.js
+js/appjs/problems/recommendations.js
 css/stopstalk.css
 css/style.css
 css/material.css
diff --git a/modules/stopstalk_constants.py b/modules/stopstalk_constants.py
@@ -50,4 +50,17 @@
 
 REQUEST_FAILURES = (SERVER_FAILURE, NOT_FOUND, OTHER_FAILURE)
 
-VIEW_ONLY_SUBMISSION_SITES = ["HackerEarth"]
+VIEW_ONLY_SUBMISSION_SITES = ["HackerEarth"]
+
+# Constants for recommendations
+PAST_PROBLEM_COUNT = 20
+DIFFICULTY_RANGE = 0.5
+RECOMMENDATION_COUNT = 10
+RECOMMENDATION_REFRESH_INTERVAL = 7
+
+RECOMMENDATION_STATUS = {
+    "RECOMMENDED": 0,
+    "VIEWED": 1,
+    "ATTEMPTED": 2,
+    "SOLVED": 3
+}
diff --git a/modules/utilities.py b/modules/utilities.py
@@ -559,12 +559,13 @@ def pretty_string(all_items):
 # ------------------------------------------------------------------------------
 def get_problems_table(all_problems,
                        logged_in_user_id,
+                       page_prefix,
                        problem_with_user_editorials=None):
     T = current.T
     db = current.db
     uetable = db.user_editorials
     table = TABLE(_class="bordered centered")
-    thead = THEAD(TR(TH(T("Problem Name"), _class="problem-search-name-column"),
+    thead = THEAD(TR(TH(T("Problem Name"), _class=generate_page_specific_class(page_prefix, "name-column")),
                      TH(T("Problem URL")),
                      TH(T("Site")),
                      TH(T("Accuracy")),
@@ -592,11 +593,13 @@ def get_problems_table(all_problems,
                                     problem["link"],
                                     link_class,
                                     link_title,
-                                    problem["id"]),
-                     _class="problem-search-name-column"))
+                                    problem["id"],
+                                    page_prefix=page_prefix),
+                     _class=generate_page_specific_class(page_prefix, "name-column")))
         tr.append(TD(A(I(_class="fa fa-link"),
                        _href=problem["link"],
-                       _class="tag-problem-link",
+                       _class=generate_page_specific_class(page_prefix, "tag-problem-link") + " tag-problem-link",
+                       data={"pid": problem["id"]},
                        _target="_blank")))
         tr.append(TD(IMG(_src=current.get_static_url("images/" + \
                                     urltosite(problem["link"]) + \
@@ -616,7 +619,7 @@ def get_problems_table(all_problems,
                                      "editorials",
                                      args=problem["id"]),
                            _target="_blank",
-                           _class="problem-search-editorial-link")))
+                           _class=generate_page_specific_class(page_prefix, "editorial-link"))))
         else:
             tr.append(TD())
 
@@ -627,7 +630,7 @@ def get_problems_table(all_problems,
                             _href=URL("problems",
                                       "tag",
                                       vars={"q": tag.encode("utf8"), "page": 1}),
-                            _class="tags-chip",
+                            _class=generate_page_specific_class(page_prefix, "tags-chip") + " tags-chip",
                             _style="color: white;",
                             _target="_blank"),
                           _class="chip"))
@@ -661,7 +664,8 @@ def problem_widget(name,
                    problem_id,
                    disable_todo=False,
                    anchor=True,
-                   request_vars={}):
+                   request_vars={},
+                   page_prefix=None):
     """
         Widget to display a problem in UI tables
 
@@ -682,9 +686,10 @@ def problem_widget(name,
                                        vars=dict(problem_id=problem_id,
                                                  **request_vars),
                                        extension=False),
-                             _class="problem-listing " + link_class,
+                             _class=generate_page_specific_class(page_prefix, "problem-listing") + " " + link_class,
                              _title=link_title,
                              _target="_blank",
+                             data={"pid": problem_id},
                              extension=False))
     else:
         problem_div.append(SPAN(name,
@@ -1474,4 +1479,8 @@ def render_user_editorials_table(user_editorials,
 
     return table
 
+# ----------------------------------------------------------------------------
+def generate_page_specific_class(page_prefix, class_name):
+    return (page_prefix + "-" + class_name) if page_prefix is not None else class_name
+
 # =============================================================================
diff --git a/private/scripts/submissions.py b/private/scripts/submissions.py
@@ -191,6 +191,8 @@ def get_submissions(user_id,
         Get the submissions and populate the database
     """
 
+    from recommendations.problems import update_recommendation_status
+
     submission_count = len(submissions)
 
     if submission_count == 0:
@@ -253,6 +255,8 @@ def get_submissions(user_id,
                               user_id,
                               custom)
 
+        update_recommendation_status(user_id, pid, submission)
+
     return submission_count
 
 # ------------------------------------------------------------------------------
diff --git a/static/js/appjs/google_analytics.js b/static/js/appjs/google_analytics.js
@@ -107,13 +107,14 @@
         addEventListener('.custom-user-list-name', 'Custom user name in Modal', false);
         addEventListener('.custom-user-modal-site-profile', 'Custom user Site Profile in Modal', false);
         addEventListener('#open-side-nav', 'Open Side Navbar', false);
-        addEventListener('#job-profile-cta', 'StopStalk Job profile CTA', false);
 
         addEventListener('#recent-announcements-update-job-profile-now', 'Onboarding StopStalk Job Profile', false);
 
         addEventListener('#problem-difficulty-later', 'Problem Difficulty modal - Later', false);
         addEventListener('#skip-this-problem', 'Problem Difficulty modal - Skip problem', false);
         addEventListener('#know-more-dashboard-page', 'Know more - Dashboard page', false);
+
+        addEventListener('#problem-recommendations-cta', 'Find me problems - Problem recommendations', false);
     };
 
     var addProblemPageButtonsToGA = function() {
@@ -170,6 +171,9 @@
     var addProblemSearchPageToGA = function() {
         addEventListener('.tag-problem-link', 'Tags problem link', false);
         addEventListener('.tags-chip', 'Tags page chip', false);
+        addEventListener('.problem-search-problem-listing', 'Problem name problem page link', false);
+        addEventListener('.problem-search-tag-problem-link', 'Problem search tags problem link', false);
+        addEventListener('.problem-search-tags-chip', 'Problem search tags page chip', false);
         addEventListener('#problem-name', 'Problem Search Problem name field', false);
         addEventListener('#profile-site', 'Problem Search Site field', false, 'change');
         addEventListener('#orderby-problem', 'Problem Search Order By field', false, 'change');
@@ -227,6 +231,24 @@
         addEventListener('.atcoder-handle-card-update-now', 'Cards - Atcoder handle update now', false);
     };
 
+    var addProblemRecommendationsPageToGA = function() {
+        addEventListener('#update-problem-recommendations', 'Refresh problem recommendations', false);
+        addEventListener('#close-refresh-recommendations', 'Close refresh problem recommendations modal', false);
+        addEventListener('#confirm-refresh-recommendations', 'Confirm refresh problem recommendations modal', false);
+        addEventListener('#recommendation-contact-us', 'Recommendation feedback', false);
+        addEventListener('.recommendation-problem-listing', 'Recommendations page problem link', false);
+        addEventListener('.recommendation-tag-problem-link', 'Recommendations page tags link', false);
+        addEventListener('.recommendation-tags-chip', 'Recommendations page tags chip', false);
+        addEventListener('.recommendation-editorial-link', 'Recommendations page editorial link', false);
+    };
+
+    var addProblemsAuthoredPageToGA = function() {
+        addEventListener('.problems-authored-problem-listing', 'Problems authored page problem link', false);
+        addEventListener('.problems-authored-tag-problem-link', 'Problems authored page tags link', false);
+        addEventListener('.problems-authored-tags-chip', 'Problems authored page tags chip', false);
+        addEventListener('.problems-authored-editorial-link', 'Problems authored page editorial link', false);
+    };
+
 
     $(document).ready(function() {
         addNavItemsToGA();
@@ -244,5 +266,7 @@
         addProblemEditorialsPageToGA();
         addDashboardPageToGA();
         addMiscellaneousToGA();
+        addProblemRecommendationsPageToGA();
+        addProblemsAuthoredPageToGA();
     });
 })(jQuery);
diff --git a/static/js/appjs/problems/recommendations.js b/static/js/appjs/problems/recommendations.js
@@ -0,0 +1,41 @@
+(function($) {
+    'use strict';
+    $(document).ready(function() {
+        $('#recommendation-refresh-modal').modal();
+
+        $('#confirm-refresh-recommendations').click(function() {
+            var $this = $(this);
+            $.ajax({
+                url: fetchRecommendationsUrl,
+                method: 'GET',
+                data: {refresh: canUpdate},
+                success: function(response) {
+                    $('#recommendations-table-content').html(response['table']);
+
+                    if (response['can_update'] === false) {
+                        $this.addClass("disabled");
+                    } else {
+                        $this.removeClass("disabled");
+                    }
+                },
+                error: function(err) {
+                  $.web2py.flash('Could not fetch new recommendations.');
+                }
+            });
+        });
+
+        $(document).on('click', '.recommendation-problem-listing, .recommendation-tag-problem-link', function() {
+            var $this = $(this);
+            var pid = $this.data('pid');
+
+            $.ajax({
+                url: '/problems/update_recommendation_status/' + pid,
+                method: 'POST',
+                success: function(response) {
+                },
+                error: function(err) {
+                }
+            })
+        });
+    });
+})(jQuery);
diff --git a/views/layout.html b/views/layout.html
@@ -83,6 +83,7 @@
     <ul id="welcome" class="dropdown-content" style="min-width: 190px; color: #536dfe;">
         {{if auth.is_logged_in():}}
             <li><a href="{{=URL('user', 'profile', args=session.handle)}}" data-analytics-label="Nav User Profile" class="nav-dropdown">{{=T("Profile")}}</a></li>
+            <li><a href="{{=URL('default', 'job_profile')}}" data-analytics-label="Nav Job Preferences" class="nav-dropdown">{{=T("Job Preferences")}}</a></li>
             <li><a href="{{=URL('user', 'submissions', args=session.handle)}}" data-analytics-label="Nav My Submissions" class="nav-dropdown">{{=T("My Submissions")}}</a></li>
             <li><a href="{{=URL('default', 'user_wise_editorials', args=session.handle)}}" data-analytics-label="Nav My Editorials" class="nav-dropdown">{{=T("My Editorials")}}</a></li>
             <li><a href="{{=URL('user', 'update_details')}}" data-analytics-label="Nav Update Details" class="nav-dropdown">{{=T("Update Details")}}</a></li>
@@ -116,7 +117,7 @@
         <div class="right">
             <span class="left">
             </span>
-            <a id="job-profile-cta" class="btn btn-default black-text" style="background-color: #f5f5f5; margin-right: 13px;" href="{{=URL('default', 'job_profile')}}" target="_blank">Job Profile</a>
+            <a id="problem-recommendations-cta" class="btn btn-default black-text" style="background-color: #fff; margin-right: 13px;" href="{{=URL('problems', 'recommendations')}}">Find Me Problems</a>
             <ul class="right" style="float: left;">
                 <li><a class="dropdown-button left" href="" data-activates="welcome"><i class="fa fa-sort-down fa-2x"></i></a></li>
             <!-- Dropdown Trigger -->
diff --git a/views/problems/recommendations.html b/views/problems/recommendations.html
@@ -0,0 +1,48 @@
+{{extend 'layout.html'}}
+<html>
+    {{block head}}
+        <title>{{=T("Problem Recommendations")}}</title>
+        <meta name="description" content="Problem recommendations">
+        <link rel="stylesheet" href="{{=URL('static', 'flag-icon/css/flag-icon.min.css')}}">
+
+        <script>
+            var fetchRecommendationsUrl = "{{=URL('problems', 'recommendations', extension='json')}}";
+            var canUpdate = ("{{=can_update}}" === "True");
+        </script>
+
+        <script src="{{=get_static_url('js/appjs/problems/recommendations.js')}}" type="text/javascript"></script>
+    {{end}}
+
+    <body>
+        <h1>{{=T("Problem Recommendations")}}</h1>
+        <div id="recommendation-refresh-modal" style="width: 50%" class="modal center">
+            <div class="modal-content">
+                <h5 style="margin-bottom: 15px;" id="recommendation-refresh-modal-header">Are you sure?</h5>
+                <div>You cannot refresh the recommendations for the next {{=RECOMMENDATION_REFRESH_INTERVAL}} days.</div>
+                <div>Please <a id="recommendation-contact-us" href="{{=URL('default', 'contact_us')}}" target="_blank">write to us</a> for feedback on recommendations!</div>
+            </div>
+            <div class="modal-footer">
+                <button id="close-refresh-recommendations" class="modal-close waves-effect orange lighten-5 btn-flat">Don't Refresh</button>
+                <button id="confirm-refresh-recommendations" class="modal-close waves-effect blue lighten-5 btn-flat">Refresh</button>
+            </div>
+        </div>
+        <div>
+            {{if can_update:}}
+                <button id="update-problem-recommendations" data-target="recommendation-refresh-modal" class="btn btn-default white-text tooltipped modal-trigger" data-delay="50" data-tooltip="Fetch new recommendations" style="margin-bottom: 15px;">Refresh</button>
+            {{else:}}
+                <div class="tooltipped" data-delay="50" data-tooltip="Can only update once in {{=RECOMMENDATION_REFRESH_INTERVAL}} days">
+                    <button id="update-problem-recommendations-disabled" class="btn btn-default disabled white-text" style="margin-bottom: 15px;">Refresh</button>
+                </div>
+            {{pass}}
+        </div>
+        <br/>
+        <div id="recommendation-table">
+            <div class="row">
+                 <div class="col offset-s1 s10 z-depth-2">
+                    <div id="recommendations-table-content">{{=table}}</div>
+                </div>
+            </div>
+        </div>
+        <br/>
+    </body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-js/appjs/problems/index.js`
	`1`	`+js/appjs/problems/recommendations.js`
	`2`	`+js/appjs/google_analytics.js`