Summarization function complete

Finished implementation of the summarization function. It is now configurable and works well with other functions (such as processing highlights) for the book module.

Author: paustian

API/TextSummarizer.php

@@ -10,28 +10,48 @@
 class TextSummarizer
 {
     private $textRank;
+    private $level;
 
-    function __construct()
+    public function __construct()
     {
         $stopWords = new English();
         $this->textRank = new TextRankFacade();
         $this->textRank->setStopWords($stopWords);
     }
 
-    function summarizeText($inText){
-        return preg_replace_callback("|<p>(.*?)</p>|", [&$this, "summarizeTextCallback"], $inText);
+    public function setSumLevel(int $inLevel, int $maxRank){
+        $this->level = 5 - $inLevel + 1;
+        $maxRank = 5 - $maxRank + 1;
+        //We don't let summarization get below the set config level
+        if($this->level < $maxRank){
+            $this->level = $maxRank;
+        }
+        if($this->level > 5){
+            $this->level = 5;
+        }
+    }
+
+    public function getSumLevel(): int {
+        return $this->level;
+    }
+
+    public function summarizeText($inText){
+        if($this->level >= 5){
+            return $inText;
+        }
+        return preg_replace_callback("|<p>(.*?)</p>|s", [&$this, "summarizeTextCallback"], $inText);
     }
 
-    function summarizeTextCallback($matches)
+    public function summarizeTextCallback($matches)
     {
         if (strlen($matches[1]) < 250) {
-            return $matches[1];
+            return "<p>" . $matches[1] . "</p>";
         }
         $textToSummarize = $matches[1];
         $sentences = $this->textRank->summarizeTextFreely(
             $textToSummarize,
             10,
-            1,
+            $this->level,
             Summarize::GET_ALL_IMPORTANT);
         $retText = "<p>";
         foreach ($sentences as $sentence) {

Controller/ConfigController.php

@@ -15,6 +15,7 @@
 
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
 use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
@@ -32,7 +33,7 @@ class ConfigController extends AbstractController
 {
     /**
      * @Route("/config")
-     * @Template("@PaustianBookModule//Config/config.html.twig")
+     * @Template("@PaustianBookModule/Config/config.html.twig")
      * @Theme("admin")
      *
      * @return array|RedirectResponse
@@ -49,7 +50,7 @@ public function config(
         $form = $this->createForm(ConfigType::class, $dataValues);
         $form->handleRequest($request);
         if ($form->isSubmitted() && $form->isValid()) {
-            if ($form->get('save')->isClicked()) {
+            if ($form->get('submit')->isClicked()) {
                 $formData = $form->getData();
                 // save modvars
                 $this->setVars($formData);

Controller/UserController.php

@@ -15,6 +15,7 @@
 
 namespace Paustian\BookModule\Controller;
 
+use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Contracts\Translation\TranslatorInterface;
 use Zikula\Bundle\CoreBundle\Controller\AbstractController;
 use Zikula\Bundle\CoreBundle\RouteUrl;
@@ -58,6 +59,8 @@ public function __construct(
         parent::__construct($extension, $permissionApi, $variableApi, $translator);
         $this->currentUserApi = $currentUserApi;
         $this->textSummarizer = new TextSummarizer();
+        //initially don't summarize the text at all.
+        $this->textSummarizer->setSumLevel(1, (int)$this->getVar('sumlevel'));
     }
 
     /**
@@ -171,7 +174,10 @@ public function displayarticle(Request $request,
         $content = $article->getContents();
         //Now add the highlights if necessary
         $uid = $this->currentUserApi->get('uid');
-        if ($uid != "") {
+        $summarize = $this->getVar('summarize');
+        $maxLevel = $this->getVar('sumlevel');
+        //Only process highlights if the text summarizing functions are off or the sumLevel is at 5 sentences (max)
+        if (($uid != "") && (!$summarize || ($this->textSummarizer->getSumLevel() == 5))) {
             //procesing the highlights goes here. This way the figure text won't matter
             $content = $this->_process_highlights($content, $article->getAid(), $this->currentUserApi);
         }
@@ -191,6 +197,8 @@ public function displayarticle(Request $request,
                     'chnumber' => $chnumber,
                     'content' => $content,
                     'return_url' => $return_url,
+                    'summarize' => $summarize,
+                    'max_level' => $maxLevel,
                     'show_internals' => $show_internals])->getContent();
 
         $repo = $this->getDoctrine()->getRepository('PaustianBookModule:BookArticlesEntity');
@@ -200,9 +208,7 @@ public function displayarticle(Request $request,
         if ($doglossary) {
             $return_text = $this->_add_glossary_defs($return_text);
         }
-        //dummy variable for now.
-        $doSummary = true;
-        if($doSummary){
+        if($summarize){
             $return_text = $this->textSummarizer->summarizeText($return_text);
         }
         return new Response($return_text);
@@ -363,6 +369,31 @@ public function displayfigure(Request $request, BookFiguresEntity $figure = null
         return new Response($figureText);
     }
 
+    /**
+     * @Route("/sumlevelchange", options={"expose"=true})
+     * @Method("POST")
+     *
+     * Grab all comments associated with this module and item ID and return them to the caller
+     * The caller is a javascript, see the javascripts in Resources/public/js directory
+     *
+     * @param Request $request
+     * @return JsonResponse|AccessDeniedException
+     */
+    public function sumlevelchange(Request $request): JsonResponse{
+        if (!$this->hasPermission($this->name . '::', '::', ACCESS_READ)) {
+            return new AccessDeniedException($this->trans('Access forbidden since you cannot read this page.'));
+        }
+        //get the summary level and set it
+        $summaryLevel = (int)$request->get('sumLevel');
+        $this->textSummarizer->setSumLevel($summaryLevel, (int)$this->getVar('sumlevel'));
+
+        //now we have to rerender the text. The $request already has the aid of the article
+        $response = $this->displayarticle($request);
+        $jsonReply = ['html' => $response->getContent(),
+                        'sumLevel' => $summaryLevel];
+        return  new JsonResponse($jsonReply);
+    }
+
     /**
      * @Route("/displayglossary")
      *

Form/ConfigType.php

@@ -30,7 +30,7 @@ public function __construct()   {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
         $builder
-            ->add('summarize',CheckboxType::class, ['label' => 'Allow summarization feature', 'required' => true])
+            ->add('summarize',CheckboxType::class, ['label' => 'Allow summarization feature', 'required' => false])
             ->add('sumlevel', RangeType::class,[
                     'label' => 'Max level of summarization (1-5, with 1 being less summarization)',
                     'attr' => [

Resources/public/css/style.css

@@ -42,4 +42,8 @@
 .glossary:hover, .glossary {
     background-color: lightgoldenrodyellow;
     color: black;
+}
+
+input.slider{
+    vertical-align:bottom;
 }

Resources/public/js/summaryModifier.js

@@ -0,0 +1,68 @@
+(function ($) {
+    $(document).ready(function () {
+        summaryModifier.init();
+    });
+
+    var summaryModifier = {
+        ajaxSettings: {
+            "dataType": "json",
+            "error": this.ajaxError,
+            "timeout": 10000
+        },
+
+        init: function () {
+            this.cacheDomAndBindEvents();
+        },
+
+        cacheDomAndBindEvents: function(){
+            this.cacheDom();
+            this.bindEvents();
+        },
+
+        cacheDom: function () {
+            this.$summaryLevel = $("input[id=summaryVal]");
+            this.$contentDiv = $(".panel-body");
+            this.$aid = $("input[id=aid]");
+        },
+
+        bindEvents: function () {
+            this.$summaryLevel.on("mouseup",  this.changeSummmary.bind(this));
+        },
+
+        changeSummmary: function (evt){
+            var sumLevel = this.$summaryLevel.val();
+            var aid = this.$aid.val();
+            //send a message to preview that item
+            this.sendAjax(
+                "paustianbookmodule_user_sumlevelchange",
+                {"sumLevel" : sumLevel,
+                        "aid": aid},
+                {"success": this.displayNewText.bind(this), method: "POST"}
+            );
+
+            evt.stopPropagation();
+        },
+
+        displayNewText: function (result, textStatus, jqXHR){
+            //extract the panel-body content from the returning text
+            var content = $(".panel-body", result.html);
+            this.$contentDiv.html(content.html());
+            //We need to redo this since we just replaced DOMS
+            this.cacheDomAndBindEvents();
+            //reset the sumlevel
+            this.$summaryLevel.val(result.sumLevel);
+        },
+
+        sendAjax: function (url, data, options) {
+            //push the data object into the options
+            options.data = data;
+            $.extend(options, this.ajaxSettings);
+            var theRoute = Routing.generate(url);
+            $.ajax(theRoute, options);
+        },
+
+        ajaxError: function(jqXHR, textStatus, errorThrown){
+            window.alert(textStatus + "\n" +errorThrown);
+        },
+    };
+})(jQuery);

Resources/views/Config/config.html.twig

@@ -11,10 +11,12 @@
     <legend>{{ 'Summarize' | trans }}</legend>
     {{ form_row(form.summarize) }}
     {{ form_row(form.sumlevel) }}
+
 </fieldset>
 <div class="form-group">
     <div class="col-lg-offset-3 col-lg-9">
-        {{ form_widget(form.add, {'attr': {'class': 'btn btn-success'}}) }}
+        {{ form_widget(form.submit, {'attr': {'class': 'btn btn-success'}}) }}
     </div>
 </div>
+
 {{ form_end(form) }}

Resources/views/User/book_user_displayarticle.html.twig

@@ -1,5 +1,6 @@
 {{ pageSetVar('title', article.title) }}
 {{ pageAddAsset('javascript', zasset('@PaustianBookModule:js/book.js')) }}
+{{ pageAddAsset('javascript', zasset('@PaustianBookModule:js/summaryModifier.js')) }}
 
 {% set formScript %}
     <script type="text/javascript">
@@ -33,6 +34,15 @@
             <p>{{ 'Chapter id:' | trans  }}{{ article.cid }}</p>
             <p>{{ 'Book id:' | trans  }}{{ article.bid }}</p>
         {% endif %}
+        <input type="hidden" id="aid" value="{{ article.aid }}" name="aid" />
+        <input type="hidden" id="cid" value="{{ article.cid }}" name="cid" />
+        <input type="hidden" id="bid" value="{{ article.bid }}" name="bid" />
+        {% if summarize %}
+        <div class="slidecontainer">
+            <label><b>Level of Text Summarization:</b></label><br />
+            <p> None <input type="range" min="1" max="{{ max_level }}" value="1" class="slider" id="summaryVal"> Max</p>
+        </div>
+        {% endif %}
         <p> <a href="{{ path('paustianbookmodule_user_toc', {bid:article.bid}) }}" title="{{ 'Table of Contents' | trans  }}" class="fa fa-book"></a>|
             <a href="{{ path('paustianbookmodule_user_displaychapter', {cid:article.cid}) }}" title="{{ 'Chapter Article List' | trans  }}" class="fa fa-bookmark"></a>|
             <a href="{{ path('paustianbookmodule_user_displayarticle', {theme:'Printer', aid:article.aid}) }}" title="{{ 'Printable Version' | trans  }}" class="fa fa-print"></a>|