[ADMIN] Init accounts for mass creation with group.

CHANGELOG.md

-
-## Version 3.0.6.2
+## TODO
 * Guided Tour
+* Sources form highlighting crawlers
 
 ## Version 3.0.6.1
-* Sources form highlighting crawlers
+* SQL Table change. Update:
+    * psql gargandb
+    * drop table contacts
+    * ./manage.py dbmigrate.py
+* Init accounts with ISC-PIF partner group
 * Link to Licence
 
 ## Version 3.0.6

gargantext/models/nodes.py

@@ -6,7 +6,6 @@ from datetime import datetime
 
 from .users import User
 
-
 __all__ = ['Node', 'NodeNode']
 
 class NodeType(TypeDecorator):

gargantext/models/users.py

@@ -3,11 +3,9 @@ from gargantext.util.db import *
 
 from datetime import datetime
 
-__all__ = ['User']
-
+__all__ = ['User', 'Contact']
 
 class User(Base):
-
     # The properties below are a reflection of Django's auth module's models.
     __tablename__ = models.User._meta.db_table
     id           = Column(Integer, primary_key=True)
@@ -48,6 +46,7 @@ class User(Base):
         return query
 
     def contacts_nodes(self, typename=None):
+        from .nodes import Node
         for contact in self.contacts():
             contact_nodes = (session
                 .query(Node)
@@ -61,15 +60,16 @@ class User(Base):
         """check if a given node is owned by the user"""
         return (node.user_id == self.id) or \
                 node.id in (contact.id for contact in self.contacts())
+    
     def get_params(self, username=None):
         print(self.__dict__.items())
         return self.hyperdata
 
 class Contact(Base):
     __tablename__ = 'contacts'
-    id = Column(Integer, primary_key=True)
-    user1_id = Column(Integer, primary_key=True)
-    user2_id = Column(Integer, primary_key=True)
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    user1_id = Column(Integer, ForeignKey(User.id, ondelete='CASCADE'))
+    user2_id = Column(Integer, ForeignKey(User.id, ondelete='CASCADE'))
     is_blocked = Column(Boolean(), default=False)
     date_creation = Column(DateTime(timezone=False))
 

gargantext/util/db.py

@@ -2,7 +2,9 @@ from gargantext           import settings
 from gargantext.util.json import json_dumps
 
 
+########################################################################
 # get engine, session, etc.
+########################################################################
 from sqlalchemy.orm import sessionmaker, scoped_session
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy import delete
@@ -25,21 +27,24 @@ Base = declarative_base()
 session = scoped_session(sessionmaker(bind=engine))
 
 
+########################################################################
 # tools to build models
-
+########################################################################
 from sqlalchemy.types import *
 from sqlalchemy.schema import Column, ForeignKey, UniqueConstraint
 from sqlalchemy.dialects.postgresql import JSONB, DOUBLE_PRECISION
 from sqlalchemy.ext.mutable import MutableDict, MutableList
 Double = DOUBLE_PRECISION
 
+########################################################################
 # useful for queries
-
+########################################################################
 from sqlalchemy.orm import aliased
 from sqlalchemy import func, desc
 
+########################################################################
 # bulk insertions
-
+########################################################################
 import psycopg2
 
 def get_cursor():
@@ -54,7 +59,6 @@ def get_cursor():
     return db, db.cursor()
 
 class bulk_insert:
-
     def __init__(self, table, fields, data, cursor=None):
         # prepare the iterator
         self.iter = iter(data)
@@ -85,7 +89,6 @@ class bulk_insert:
 
     readline = read
 
-
 def bulk_insert_ifnotexists(model, uniquekey, fields, data, cursor=None, do_stats=False):
     """
     Inserts bulk data with an intermediate check on a uniquekey

init_accounts.py

@@ -26,10 +26,131 @@ django_models_names = set(model._meta.db_table for model in django_models)
 
 
 from gargantext.util.db      import session
-from gargantext.models.users import User
+from gargantext.models.users import User, Contact
 from django.core.mail        import send_mail
 from gargantext.settings     import BASE_URL
 
+drafts = {
+        'partnerOk' : '''
+        Bonjour,
+
+        Vous avez fait une demande d'accès à la plate-forme
+        Gargantext. L'équipe de l'ISC-PIF a tout mis en œuvre pour
+        vous donner accès à cette plate-forme dans les meilleurs
+        délais.
+
+        Nous vous recommendons de prendre connaissance des conditions
+        d'utilisation de la plate-forme à l'adresse ci-dessous en
+        attirant votre attention sur les points suivants :
+
+        1 - L'usage de cette plate-forme est réservé à un cadre académique,
+
+        2 - Le service Gargantext est un service d'analyse de données,
+        et non de stockage. Il appartient à chaque utilisateur
+        d'assurer la sauvegarde de ses propres données et résultats en
+        les téléchargeant à partir de la plate-forme.
+
+        3 - La réutilisation des données, graphiques, analyses et
+        cartographies générés par Gargantext dans toute publication
+        et communication suppose la mention explicite de Gargantext et
+        de l'ISC-PIF CNRS comme par exemple : "ces résultats ont été
+        obtenus à l'aide de du logiciel Gargantext développé par
+        ISC-PIF/CNRS".
+
+        Lire l'intégralité des conditions d'utilisation (recommandé) sur :
+        http://gitlab.iscpif.fr/humanities/tofu/tree/master
+        
+        Vous pouvez vous connecter à l'adresse:
+                http://%s
+        
+        Avec les identifiants suivants:
+        Votre login est: %s
+        Votre mot de passe est : %s
+
+        Vous êtes actuellement sur cette version stabilisée pour une
+        expérience unique dans l'exploration de vos thèmes de recherche.
+
+        Vos retours seront précieux pour poursuivre le développement
+        de la plateforme, n'hésitez pas à nous contacter et
+        contribuer!
+
+        Si vous souhaitez accéder à vos anciens corpus, vos anciens
+        codes d'accès restent valides à cette adresse jusqu'au 30 juin
+        2017 minuit:
+
+                http://old.gargantext.org
+
+        Nous restons à votre disposition pour tout complément d'information.
+        Cordialement
+        --
+            L'équipe de Gargantext (CNRS)
+
+        '''
+        ,
+
+        'partnerKo' : '''
+        Bonjour,
+
+        Vous venez de faire une demande d'accès à la plate-forme
+        Gargantext, développée et hébergée grâce au soutien du CNRS
+        et des partenaires de l'ISC-PIF. L'équipe de l'ISC-PIF a tout
+        mis en œuvre pour vous donner accès à cette plate-forme dans
+        les meilleurs délais.
+
+        Cette plate-forme étant accessible en priorité au personnel
+        des établissements partenaires de l'ISC-PIF, nous vous
+        proposons un accès pour une durée de 3 mois afin que vous
+        puissiez explorer les possibilités de Gargantext. S'il s'avère
+        que cette plateforme correspond à vos besoins, vous pourrez
+        vous prendre contact avec le service partenariat de l'ISC-PIF
+        (contact@gargantext.org) pour étudier une adhésion de votre
+        établissement à l'ISC-PIF ou bien vous rapprocher de votre
+        établissement afin qu'il déploie une instance de Gargantext.
+
+        Nous vous invitons à prendre connaissance des conditions
+        d'utilisation de la plate-forme à l'adresse ci-dessous en
+        attirant votre attention sur les points suivants :
+
+        1 - L'usage de cette plate-forme est réservé à un cadre académique,
+
+        2 - Le service Gargantext est un service d'analyse de données,
+        et non de stockage. Il appartient à chaque utilisateur
+        d'assurer la sauvegarde de ses propres données et résultats en
+        les téléchargeant à partir de la plate-forme.
+
+        3 - La réutilisation des données, graphiques, analyses et
+        cartographies générés par Gargantext dans toute publication
+        et communication suppose la mention explicite de Gargantext et
+        de l'ISC-PIF CNRS comme par exemple : "ces résultats ont été
+        obtenus à l'aide de du logiciel Gargantext développé par
+        ISC-PIF/CNRS".
+
+        Lire l'intégralité des conditions d'utilisation (recommandé) sur :
+        http://gitlab.iscpif.fr/humanities/tofu/tree/master
+
+        Vous pouvez donc vous connecter à l'adresse:
+                http://%s
+        
+        Avec les identifiants suivants:
+        Votre login est: %s
+        Votre mot de passe est : %s
+
+        Vous êtes actuellement sur cette version stabilisée pour une
+        expérience unique dans l'exploration de vos thèmes de recherche.
+
+        Vos retours seront précieux pour poursuivre le développement
+        de la plateforme, n'hésitez pas à nous contacter et
+        contribuer!
+
+        Nous restons à votre disposition pour tout complément d'information.
+        Cordialement
+        --
+            L'équipe de Gargantext (CNRS)
+
+        ''' ,
+
+        }
+
 def make_random_password(length=10
                          , allowed_chars='abcdefghjkmnpqrstuvwxyz'
                                          'ABCDEFGHJKLMNPQRSTUVWXYZ'
@@ -42,91 +163,131 @@ def make_random_password(length=10
     """
     return get_random_string(length, allowed_chars)
 
+def mail2user(username, email, password, draft):
+    send_mail ('[Gargantext] Votre accès à la plateforme'
+              , draft % (BASE_URL, username, password)
+              , 'team@gargantext.org'
+              , [email]
+              , fail_silently=False 
+              )
 
-def notify_user(username, email, password):
-    message = '''
-    Bonjour,
-    votre compte Gargantext vient d'être mis à jour.
+def block(user1_id, user2_id, bool_):
+    '''
+    user_group :: Int -> Int -> Bool
+    Link between user1 and user2
+    If False: 
+        link blocked
+    else:
+        link not blocked
 
-    Vous pouvez vous connecter à l'adresse:
-            http://%s
+    '''
+    contact = Contact()
     
-    Avec les identifiants suivants:
-    Votre login est: %s
-    Votre mot de passe est : %s
-
-    La nouvelle version, Blue Jasmin, est sortie!
-
-    Vous êtes actuellement sur cette version stabilisée pour une
-    expérience unique dans l'exploration de vos thèmes de recherche.
-
-    Cependant, vos retours seront précieux pour poursuivre le
-    développement de la plateforme: merci d'avance!
-
-    Si vous souhaitez accéder à vos anciens corpus, vos codes d'accès
-    sont valides à cette adresse jusqu'en 30 juin 2017 minuit:
-            http://old.gargantext.org
+    contact.user1_id   = user1_id
+    contact.user2_id   = user2_id
+    contact.is_blocked = bool_
 
-    Nous restons à votre disposition pour tout complément d'information.
-    Cordialement
-    --
-        L'équipe de Gargantext (CNRS)
-
-    ''' % (BASE_URL,username, password)
-
-    send_mail('[Gargantext] Votre accès à la plateforme', message, 'team@gargantext.org', [email], fail_silently=False )
+    session.add(contact)
+    session.commit()
+    
+    return contact
 
-    # add option for mass sending email
+def create_user(username, email, user=None, password=None, group=None, notify=False):
+    '''
+    create_user :
+        - create user
+        - create its group if needed
+        - create relation between user and its group
 
-def create_user(username, email, user=None, password=None, active=False, notify=True):
+    '''
     if user is None:
         user = User()
+    
     user.username    = username
     user.email       = email
-    user.is_active = True
-    if password is None or password == "":
+    user.is_active   = True
+    
+    # Creating the password
+    if password is None or len(password) < 3 :
         password = make_random_password()
     user.password = make_password(password)
+
     session.add(user)
     session.commit()
 
-    if notify == True:
-        notify_user(username, email, password)
+    if group is not None :
+        # get or create group_iscpif
+        group_iscpif_id = session.query(User.id).filter(User.username=="group_iscpif").first()
+        
+        if group_iscpif_id is None:
+            group_iscpif    = create_user("group_iscpif", "group@gargantext.org", group=None, notify=False)
+            group_iscpif_id = group_iscpif.id
+
+        if group == "group_iscpif":
+            block (user.id, group_iscpif_id, False)
+        else:
+            block (user.id, group_iscpif_id, True)
+
+
+    if notify == True and group == "group_iscpif" :
+        mail2user (username, email, password, drafts['partnerOk'])
+    elif notify == True :
+        mail2user (username, email, password, drafts['partnerKo'])
+    else:
+        print("User %s created, no notification" % username)
 
     return user
 
-def delete_user(username):
+def del_user(username):
+    '''
+    del_user :: String -> ()
+    '''
+    print("Test is True, deleting username %s" % username)
     session.query(User).filter(User.username == username).delete()
 
-def active_user(username, active=True):
+def active_user(username, bool_=True):
     '''
-    To get inactive, active=False
+    active_user :: String -> Maybe Bool -> ()
+    if bool_ == True:
+        user is active
+    else:
+        user is not active
     '''
     user = session.query(User).filter(User.username == username).first()
-    user.is_active = True
+    user.is_active = bool_
     user.save()
 
-def mass_account_creation(fichier=None,init=False):
-    if fichier is None:
-        fichier = "/tmp/comptes.csv"
-    accounts = open(fichier, "r")
+def mass_account_creation(csv_file=None, init=False, test=False, notify=False):
+    '''
+    CSV file as parameter:
+    if partner:
+        username,email@example.com,group_iscpif,password,
+    else:
+        username,email@example.com,group_others,password,
+    '''
+    accounts = open(csv_file, "r")
     for line in accounts.readlines():
-        username, email, password, fin = line.split(',')
+        username, email, group, password, end = line.split(',')
         user = session.query(User).filter(User.username == username).first()
 
         if user is not None:
-            print("User %s does exist already" % (username))
             if init == True:
-                create_user(username, email, user=user, password=password, active=True, notify=True)
-                print("User %s updated" % (username))
+                create_user(username, email, user=user, group=group, password=password, notify=notify)
+                print("User %s exists and updated" % (username))
+            else:
+                print("User %s exists and not updated" % (username))
+
         else:
-            print("User %s does not exist already" % (username))
-            create_user(username, email, password=password, active=True, notify=True)
-            print("User %s createed" % (username))
-        #delete_user(username)
+            create_user(username, email, group=group, password=password, notify=notify)
+            print("User %s is created" % (username))
+        
+        if test==True:
+            del_user(username)
+            del_user(group)
+    
     accounts.close()
 
 if __name__ == "__main__":
-    mass_account_creation(fichier=sys.argv[1], init=True)
+    mass_account_creation(csv_file=sys.argv[1], init=True, notify=True, test=False)