JWSTPCR-135: MAST token in login, login_gui, set_token and documentation

Author: jespinosaar

astroquery/jwst/core.py

@@ -38,6 +38,7 @@
 from .data_access import JwstDataHandler
 
 from builtins import isinstance
+from astroquery.jwst.token import TokenDialog
 
 __all__ = ['Jwst', 'JwstClass']
 
@@ -947,7 +948,7 @@ def save_results(self, job, verbose=False):
         return self.__jwsttap.save_results(job, verbose)
 
     def login(self, user=None, password=None, credentials_file=None,
-              verbose=False):
+              token=None, verbose=False):
         """Performs a login.
         TAP+ only
         User and password can be used or a file that contains user name and
@@ -963,13 +964,17 @@ def login(self, user=None, password=None, credentials_file=None,
         credentials_file : str, mandatory if no 'user' & 'password' are
             provided
             file containing user and password in two lines
+        token: str, optional
+            MAST token to have access to propietary data
         verbose : bool, optional, default 'False'
             flag to display information about the process
         """
-        return self.__jwsttap.login(user=user,
-                                    password=password,
-                                    credentials_file=credentials_file,
-                                    verbose=verbose)
+        self.__jwsttap.login(user=user,
+                             password=password,
+                             credentials_file=credentials_file,
+                             verbose=verbose)
+        if token:
+            self.set_token(token)
 
     def login_gui(self, verbose=False):
         """Performs a login using a GUI dialog
@@ -982,6 +987,31 @@ def login_gui(self, verbose=False):
         """
         return self.__jwsttap.login_gui(verbose)
 
+    def login_token_gui(self, verbose=False):
+        """Performs a login using a GUI dialog
+        TAP+ only, with an additiona field to
+        specify a token
+
+        Parameters
+        ----------
+        verbose : bool, optional, default 'False'
+            flag to display information about the process
+        """
+        connHandler = self.__jwsttap._TapPlus__getconnhandler()
+        url = connHandler.get_host_url()
+        loginDialog = TokenDialog(url)
+        loginDialog.show_login()
+        if loginDialog.is_accepted():
+            user = loginDialog.get_user()
+            pwd = loginDialog.get_password()
+            if loginDialog.get_token():
+                token = loginDialog.get_token()
+                self.login(user=user, password=pwd, token=token,
+                           verbose=verbose)
+            else:
+                self.login(user=user, password=pwd, verbose=verbose)
+            # execute login
+
     def logout(self, verbose=False):
         """Performs a logout
         TAP+ only
@@ -993,6 +1023,19 @@ def logout(self, verbose=False):
         """
         return self.__jwsttap.logout(verbose)
 
+    def set_token(self, token):
+        """Links a MAST token to the logged user
+
+        Parameters
+        ----------
+        token: str, mandatory
+            MAST token to have access to propietary data
+        """
+        subcontext = 'session'
+        data = 'action=set&key=mast_token&value=' + token
+        self.__jwsttap._TapPlus__getconnhandler().execute_tappost(subcontext,
+                                                              data)
+
     def get_product_list(self, observation_id=None,
                          cal_level="ALL",
                          product_type=None):

astroquery/jwst/token.py

@@ -0,0 +1,150 @@
+# Licensed under a 3-clause BSD style license - see LICENSE.rst
+"""
+=======================
+LOGIN WITH TOKEN DIALOG
+=======================
+
+@author: Javier Espinosa Aranda
+@contact: [email protected]
+
+European Space Astronomy Centre (ESAC)
+European Space Agency (ESA)
+
+Created on 04 sept. 2020
+
+
+"""
+
+import six
+
+try:
+    from six.moves.tkinter import Tk as TKTk
+except ImportError:
+    TKTk = None
+
+try:
+    from six.moves.tkinter import Toplevel as TKToplevel
+except ImportError:
+    TKToplevel = None
+
+try:
+    from six.moves.tkinter import Button as TKButton
+except ImportError:
+    TKButton = None
+
+try:
+    from six.moves.tkinter import Label as TKLabel
+except ImportError:
+    TKLabel = None
+
+try:
+    from six.moves.tkinter import Entry as TKEntry
+except ImportError:
+    TKEntry = None
+
+
+class TokenDialog(object):
+
+    def __init__(self, host):
+        self.__interna_init()
+        self.__host = host
+        self.__initialized = False
+        if TKTk is not None:
+            self.__create_content()
+            self.__initialized = True
+
+    def __interna_init(self):
+        self.__rootFrame = None
+        self.__top = None
+        self.__usrEntry = None
+        self.__pwdEntry = None
+        self.__tokenEntry = None
+        self.__accepted = False
+        self.__host = None
+        self.__usr = None
+        self.__pwd = None
+        self.__token = None
+
+    def __cancel_action(self):
+        self.__accepted = False
+        self.__rootFrame.destroy()
+
+    def __login_action(self):
+        self.__accepted = True
+        self.__usr = self.__usrEntry.get()
+        self.__pwd = self.__pwdEntry.get()
+        self.__token = self.__tokenEntry.get()
+        self.__rootFrame.destroy()
+
+    def __enter_action(self, event):
+        self.__login_action()
+
+    def __create_content(self):
+        self.__rootFrame = TKTk()
+        self.__rootFrame.withdraw()
+
+        self.__top = TKToplevel(self.__rootFrame)
+        self.__top.title("Login")
+        self.__top.protocol("WM_DELETE_WINDOW", self.__rootFrame.destroy)
+
+        self.__top.bind('<Return>', self.__enter_action)
+
+        self.__top.update_idletasks()
+        width = self.__top.winfo_width()
+        height = self.__top.winfo_height()
+        x = (self.__top.winfo_screenwidth() // 2) - (width // 2)
+        y = (self.__top.winfo_screenheight() // 2) - (height // 2)
+
+        self.__top.geometry("+%d+%d" % (x, y))
+
+        row = 0
+        expLabel = TKLabel(self.__top, text='Login to host:')
+        expLabel.grid(row=row, column=0, columnspan=4, padx=5, pady=2)
+
+        row = row+1
+        urlLabel = TKLabel(self.__top, text=self.__host)
+        urlLabel.grid(row=row, column=0, columnspan=4, padx=5, pady=2)
+
+        row = row+1
+        usrLabel = TKLabel(self.__top, text='User')
+        usrLabel.grid(row=row, column=0, columnspan=2, padx=20, pady=5)
+        self.__usrEntry = TKEntry(self.__top, width=20)
+        self.__usrEntry.grid(row=row, column=2, columnspan=2, padx=5, pady=5)
+
+        row = row+1
+        pwdLabel = TKLabel(self.__top, text='Password')
+        pwdLabel.grid(row=row, column=0, columnspan=2, padx=20, pady=5)
+        self.__pwdEntry = TKEntry(self.__top, width=20, show="*")
+        self.__pwdEntry.grid(row=row, column=2, columnspan=2, padx=5, pady=5)
+
+        row = row+1
+        tokenLabel = TKLabel(self.__top, text='Token')
+        tokenLabel.grid(row=row, column=0, columnspan=2, padx=20, pady=5)
+        self.__tokenEntry = TKEntry(self.__top, width=20)
+        self.__tokenEntry.grid(row=row, column=2, columnspan=2, padx=5, pady=5)
+
+        row = row+1
+        cancelButton = TKButton(self.__top, text='Cancel', command=self.__cancel_action)
+        cancelButton.grid(row=row, column=1, padx=5, pady=5)
+        loginButton = TKButton(self.__top, text='Login', command=self.__login_action)
+        loginButton.grid(row=row, column=2, padx=5, pady=5)
+
+    def show_login(self):
+        if self.__initialized:
+            self.__usrEntry.focus_set()
+            self.__rootFrame.mainloop()
+        else:
+            print("tkinter python module is not available.\n\
+            Please, install tkinter module or use command line login utility.")
+
+    def is_accepted(self):
+        return self.__accepted
+
+    def get_user(self):
+        return self.__usr
+
+    def get_password(self):
+        return self.__pwd
+
+    def get_token(self):
+        return self.__token

docs/jwst/jwst.rst

@@ -630,7 +630,7 @@ To remove asynchronous
 ---------------------------
 
 Authenticated users are able to access to TAP+ capabilities (shared tables, persistent jobs, etc.)
-In order to authenticate a user, ``login`` or ``login_gui`` methods must be called. After a successful
+In order to authenticate a user, ``login``, ``login_gui`` or ``login_token_gui`` methods must be called. After a successful
 authentication, the user will be authenticated until ``logout`` method is called.
 
 All previous methods (``query_object``, ``cone_search``, ``load_table``, ``load_tables``, ``launch_job``) explained for
@@ -640,12 +640,13 @@ The main differences are:
 
 * Asynchronous results are kept at server side for ever (until the user decides to remove one of them).
 * Users can access to shared tables.
+* ``login_token_gui`` allows the user to include a MAST token to download propietary data. It is also possible to set a token after logging using ``set_token`` function.
 
 
 2.1. Login/Logout
 ~~~~~~~~~~~~~~~~~
 
-Graphic interface
+Using the graphic interface:
 
 
 *Note: Tkinter module is required to use login_gui method.*
@@ -655,9 +656,14 @@ Graphic interface
   >>> from astroquery.jwst import Jwst
   >>> Jwst.login_gui()
 
+If the user wants to specify a MAST token to download propietary data:
 
-Command line
+.. code-block:: python
+
+  >>> from astroquery.jwst import Jwst
+  >>> Jwst.login_token_gui()
 
+Using the command line:
 
 .. code-block:: python
 
@@ -674,7 +680,21 @@ It is possible to use a file where the credentials are stored:
   >>> from astroquery.jwst import Jwst
   >>> Jwst.login(credentials_file='my_credentials_file')
 
+MAST tokens can also be implemented in command line functions:
+
+.. code-block:: python
+
+  >>> from astroquery.jwst import Jwst
+  >>> Jwst.login(user='userName', password='userPassword', token='mastToken')
+
+If the user is logged in and a MAST token has not been included or must be changed, it can be
+specified using the ``set_token`` function. 
+
+.. code-block:: python
 
+  >>> from astroquery.jwst import Jwst
+  >>> Jwst.login(user='userName', password='userPassword')
+  >>> Jwst.set_token(token='mastToken')
 
 To perform a logout