Usernavigation - Check if table of contents

api/models/heuristics/easeofnavigation.py

@@ -1,7 +1,68 @@
 from models.heuristic import Heuristic
+from boilerpipe.extract import Extractor
+
+import re
 
 # Formal 3
 # Ensure ease of user navigation.
 class EaseOfNavigation(Heuristic):
     def score(self, eula):
-        return {'score': -1, 'max': 4, 'reason': 'Not implemented'}
+
+        if eula.html is not None:
+            # gets actual text since eula.text doesn't get everything
+            extractor = Extractor(extractor='KeepEverythingExtractor', html= eula.html)
+            text = extractor.getText()
+        else:
+            text = eula.text
+
+        # limit text to first 1000 characters
+        text_first_1000 = text[:1000]
+        tocscore = 0 # score for table of contents
+        reason = '' # reason
+        index_of_table = -1 # index of matching text
+
+        # text to look out for
+        tocindicators = ['TABLE OF CONTENTS', 'Table Of Contents']
+
+        # find index of indicator text
+        for ind in tocindicators:
+            if index_of_table < 0:
+                index_of_table = text_first_1000.find(ind)
+            else:
+                break
+
+        if eula.html:
+
+            # find all table of contents entries and their hrefs
+            link_match = re.findall('(?<=<a href="#).+?(?=")', eula.html)
+            #print 'link matches', link_match
+
+            # find targets of table of contents hyperlinks
+            name_match = re.findall('(?<=<a name=").+?(?=")', eula.html)
+            name_match += re.findall('(?<=<a id=").+?(?=")', eula.html)
+            #print 'name matches', name_match
+
+            toc_hyperlinked = False
+            matches = 0
+            expected_matches = len(link_match)
+            for i in link_match:
+                found_match = False
+                for j in name_match:
+                    if i == j:
+                        found_match = True
+                        break
+                if found_match:
+                    matches += 1
+
+            #print matches, expected_matches
+            if matches > 0.75 * expected_matches:
+                toc_hyperlinked = True
+
+
+            # Score of 4 if found, score of 0 if not
+            # TODO: additional scoring hyperlinked vs unlinked table
+            tocscore = 4 if toc_hyperlinked else 2
+        else:
+            tocscore = 4 if index_of_table >= 0 else 0
+
+        return {'score': tocscore, 'max': 4, 'index': index_of_table}