src/jalview/gui/UserQuestionnaireCheck.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.util.MessageManager;
  24 import jalview.util.Platform;
  25
  26 import java.io.BufferedReader;
  27 import java.io.InputStreamReader;
  28 import java.net.URL;
  29
  30 public class UserQuestionnaireCheck implements Runnable
  31 {
  32   /**
  33    * Implements the client side machinery for detecting a new questionnaire,
  34    * checking if the user has responded to an existing one, and prompting the
  35    * user for responding to a questionnaire. This is intended to work with the
  36    * perl CGI scripts checkresponder.pl and questionnaire.pl
  37    */
  38   String url = null;
  39
  40   UserQuestionnaireCheck(String url)
  41   {
  42     if (url.indexOf("questionnaire.pl") == -1)
  43     {
  44       jalview.bin.Cache.log.error("'" + url
  45               + "' is an Invalid URL for the checkForQuestionnaire() method.\n"
  46               + "This argument is only for questionnaires derived from jalview's questionnaire.pl cgi interface.");
  47     }
  48     else
  49     {
  50       this.url = url;
  51     }
  52   }
  53
  54   String qid = null, rid = null;
  55
  56   private boolean checkresponse(URL qurl) throws Exception
  57   {
  58     jalview.bin.Cache.log.debug("Checking Response for : " + qurl);
  59     boolean prompt = false;
  60     // see if we have already responsed to this questionnaire or get a new
  61     // qid/rid pair
  62     BufferedReader br = new BufferedReader(
  63             new InputStreamReader(qurl.openStream()));
  64     String qresp;
  65     while ((qresp = br.readLine()) != null)
  66     {
  67       if (qresp.indexOf("NOTYET:") == 0)
  68       {
  69         prompt = true; // not yet responded under that ID
  70       }
  71       else
  72       {
  73         if (qresp.indexOf("QUESTIONNAIRE:") == 0)
  74         {
  75           // QUESTIONNAIRE:qid:rid for the latest questionnaire.
  76           int p = qresp.indexOf(':', 14);
  77           if (p > -1)
  78           {
  79             rid = null;
  80             qid = qresp.substring(14, p);
  81             if (p < (qresp.length() - 1))
  82             {
  83               rid = qresp.substring(p + 1);
  84               prompt = true; // this is a new qid/rid pair
  85             }
  86           }
  87         }
  88       }
  89     }
  90     return prompt;
  91   }
  92
  93   @Override
  94   public void run()
  95   {
  96     if (url == null)
  97     {
  98       return;
  99     }
 100     boolean prompt = false;
 101     try
 102     {
 103       // First - check to see if wee have an old questionnaire/response id pair.
 104       String lastq = jalview.bin.Cache.getProperty(Preferences.QUESTIONNAIRE);
 105       if (lastq == null)
 106       {
 107         prompt = checkresponse(new URL(url
 108                 + (url.indexOf('?') > -1 ? "&" : "?") + "checkresponse=1"));
 109       }
 110       else
 111       {
 112         String qurl = url + (url.indexOf('?') > -1 ? "&" : "?")
 113                 + "checkresponse=1";
 114         // query the server with the old qid/id pair
 115         String qqid = lastq.indexOf(':') > -1
 116                 ? lastq.substring(0, lastq.indexOf(':'))
 117                 : null;
 118         if (qqid != null && qqid != "null" && qqid.length() > 0)
 119         {
 120           qurl += "&qid=" + qqid;
 121           qid = qqid;
 122           String qrid = lastq.substring(lastq.indexOf(':') + 1); // retrieve
 123           // old rid
 124           if (qrid != null && !qrid.equals("null"))
 125           {
 126             rid = qrid;
 127             qurl += "&rid=" + qrid;
 128           }
 129         }
 130         // see if we have already responsed to this questionnaire.
 131         prompt = checkresponse(new URL(qurl));
 132       }
 133       if (qid != null && rid != null)
 134       {
 135         // Update our local property cache with latest qid and rid
 136         jalview.bin.Cache.setProperty(Preferences.QUESTIONNAIRE, qid + ":" + rid);
 137       }
 138       if (prompt)
 139       {
 140         String qurl = url + (url.indexOf('?') > -1 ? "&" : "?") + "qid="
 141                 + qid + "&rid=" + rid;
 142         jalview.bin.Cache.log
 143                 .info("Prompting user for questionnaire at " + qurl);
 144         int reply = JvOptionPane.showInternalConfirmDialog(Desktop.getDesktopPane(),
 145                 MessageManager.getString("label.jalview_new_questionnaire"),
 146                 MessageManager.getString("label.jalview_user_survey"),
 147                 JvOptionPane.YES_NO_OPTION, JvOptionPane.QUESTION_MESSAGE);
 148
 149         if (reply == JvOptionPane.YES_OPTION)
 150         {
 151           jalview.bin.Cache.log.debug("Opening " + qurl);
 152           Platform.openURL(qurl);
 153         }
 154       }
 155     } catch (Exception e)
 156     {
 157       jalview.bin.Cache.log
 158               .warn("When trying to access questionnaire URL " + url, e);
 159     }
 160   }
 161
 162 }