Skip to end of metadata
Go to start of metadata

Le Canal Stockage évolue pour devenir Esup File Manager (anciennement Esup Portlet Stockage) et apporter de nouvelles fonctionnalités.

Portlet JSR168, utilisation de Esup Commons V2  allié à Spring MVC, Web 2.0, interface WAI, interface pensée pour mobiles et interaction avec ESUP-ECM (support de CMIS) font parties des points importants de cette évolution.

La version esup-filemanager 2.2.2 est maintenant disponible.

Spécifications

On peut retrouver les premières spécifications d'Esup File Manager ici .

Fonctionnalités

  • full ajax pour les navigateurs (utilisation de jquery, upload via jquery également).
  • interface WAI (accessible) spécifique
  • look (et ergonomie) portlet mobile spécifique sans ajax : on propose une navigation simple pour consultation uniquement (pas de copier/coller/uploads ...)
  • copier/couper/coller, renommage, création de répertoire, upload/download de fichier.
  • copier/couper/coller inter-serveurs
  • utilisation de apache commons vfs pour l'accès aux serveurs de fichiers et donc supporte théoriquement les différents files systems supportés par vfs : cf http://commons.apache.org/vfs/filesystems.html -> la configuration du serveur utilise pour uri le format vfs ( file:///home/bob fonctionne par exemple );
  • support de CMIS via Apache Chemistry (connexion avec Esup-ECM/Nuxeo disponible)
  • support de WEBDAV via Sardine
  • support de CIFS via JCIFS
  • pensé techniquement pour pouvoir implémenter d'autres supports que via apache commons vfs et Apache Chemistry
  • utilise au mieux spring v3, mvc (2.5 pour la portlet), les annotations, etc.
  • propose un fichier de configurations pour les différents serveurs / "drives" disponibles (en portlet, peut être fonction de l'appartenance à un groupe, de la présence d'un attribut utilisateur ou/et de la présence d'un "token" dans les préférences du context de la portlet).
  • supporte 4 modes d'authentification : pas d'authentification, authentification username/password donné en dur dans le fichier de configuration, authentification username/password récupéré de l'utilisateur par un formulaire,  authentification proxy cas en portlet via uPortal (testé et validé sur du sftp cassifié).
  • supporte également 2 authentifications supplémentaires spécifiques pour Esup-ECM / Nuxeo (CMIS) :
    • 1 qui peut être utilisée lorsque Nuxeo est doté du plugin nuxeo-platform-login-shibboleth : pour ce faire esup-filemanager a le même comportement que le mod shib d'apache vis à vis de Nuxeo
    • 1 autre qui utilise "NuxeoPortalSSOAuthenticationProvider" (cf doc Nuxeo à ce propos) et requiert donc le plugin nuxeo-platform-login-portal-sso
      A noter que dans les 2 cas, l'authentification se fait en propageant les paramètres d'authentification via les entêtes HTTP. A noter également que CMIS étant sans état, la session avec Nuxeo n'est pas maintenue et une (ré)authentification est requise pour chaque commande CMIS, aussi l'authentification par ProxyCAS parait trop coûteuse à l'usage et esup-filemanager ne la propose tout simplement pas pour CMIS (Nuxeo).

TODO

Téléchargement

Vous pouvez trouver la dernière version d'esup-filemanager archivée sur sourcesup :

https://sourcesup.renater.fr/frs/download.php/4175/esup-filemanager-2.2.2.tgz

Gestion des sources

Afin de faciliter la collaboration autour de ce projet, nous utilisons GITHUB pour gérer le développement d'esup-filemanager :

https://github.com/EsupPortail/esup-filemanager

  1. esup-filemanager-portlet_1_0 branch
    Branche de développement de la version compatible "portlet 1.0" (JSR 168) - les releases d'esup-filemanager en 2.x.x proviennent de cette branche directement.
    [pour infos : voir ci-dessous comment appeler mvn jetty:run pour tester rapidement cette version]
  2. master branch
    Branche de développement pour les futures versions d'esup-filemanager - elle utilise "portlet 2.0" API (JSR 286) - ces futures versions seront taguées en 3.x.x.
    [pour infos : sur cette version d'esup-filemanager vous ne pouvez plus appeler mvn jetty:run pour tester rapidement esup-filemanager - en lieu et place utilisez la commande mvn portlet-prototyping:run]

Déploiement Test - Servlet

Une fois dézippée, vous pouvez directement tester esup-filemanager ... en mode servlet !

Pour cela il vous faut avoir un apache maven de disponible sur votre machine, en ligne de commande et depuis le répertoire dans lequel se trouve le fichier pom.xml tapez simplement

Depuis un navigateur, vous pouvez alors appeler une URL du type :

http://localhost:8080/esup-filemanager/servlet-ajax/

Notez que le "drive" Bob correspond à file:/// par défaut.

Note: le mode servlet d'esup-filemanager est un mode "dégradé" de cette application, en effet en mode servlet vous ne bénéficiez pas :

  • du CAS : la servlet n'est pas cassifiée ; la portlet fait du proxy-cas.
  • de l'interface accessible WAI 
  • de la vue mobile/smartphone 
  • de la récupération d'attributs utilisateurs depuis le portail (récupération des groupes comprise)

Aussi voyez le mode servlet comme une facilité de mise au point, de développement d'esup-filemanager qui reste (actuellement en tout cas) destinée à fonctionner en portlet JSR168.

Déploiement Portlet - Esup v4 / uPortal 4

La procédure est la même qu'en Esup v3 / uPortal 3.

A noter :

  • esup-filemanager 2.0.0 n'est pas supporté par EsupPortail / uPortal 4 (tests effectués sur un socle uPortal 4.0.4)
  • esup-filemanager 2.1.0 (et supérieur mais inférieur à 3.0.0) fonctionne à la fois sur EsupPortail / uPortal v3 et EsupPortail / uPortal v4 (tests effectués sur un socle uPortal 4.0.4)
  • Attention, esup-filemanager va maintenant investir les nouvelles possibilités offertes par JSR 286 (portlet 2.0), aussi dans ses versions 3.0.0 et supérieur, celui-ci ne sera plus compatible avec les portails JSR168 (dont EsupPortail / uPortal v2 et v3)

En version inférieure à 3.0.0, le contexte esup-filemanager (servlet) a besoin de partager des objets en session avec le contexte uPortal (servlet).
Aussi merci de vérifier que vous avez bien défini des attributs emptySessionPath="true" dans le/les Connector AJP/HTTP de server.xml du Tomcat
Pour plus de détails, voir la configuration du wiki Jasig à ce propos : https://wiki.jasig.org/pages/viewpage.action?pageId=29133275
Cela sous peine d'obtenir une erreur du type :

Déploiement Portlet - Esup v3 / uPortal 3

Les fichiers que l'exploitant est amené à modifier sont les suivant :

  • src/main/webapp/WEB-INF/context/drives.xml
    C'est le fichier de configuration principale de l'application, il vous permet de définir les catégories et les drives ("serveurs") associés.
    Pour un usage en portlet, donnez dans ce fichier la valeur java.lang.Boolean.TRUE à la constante  isPortlet
  • src/main/webapp/WEB-INF/portlet.xml
    Les balises user-attribute peuvent être à modifier selon votre configuration.
  • src/main/webapp/WEB-INF/web.xml
    Si vous souhaitez utiliser une authentification ProxyCas, vous devrez indiquer l'adresse de votre serveur CAS dans web.xml

Pour déployer esup-filemanager en portlet dans un Esup / uPortal, vous devrez lancer une commande similaire à celle-ci :

Déploiement Portlet - Esup v2 / uPortal 2

Nous avons testé le déploiement de la portlet sur un uPortal_rel-2-6-1-GA-quick-start de la même façon que pour une version 3, cela fonctionne bien.

Il faudra cependant faire attention aux points suivants :

  • le ant deployPortletApp permet comme en V3 (en plus de déployer le war) de modifier comme nécessaire le web.xml en y spécifiant les paramètres pluto adéquates. le web.xml ainsi modifié nous indique que le guid est positionné à esup-filemanager.esup-filemanager  -> utile à savoir pour la publication de la portlet en 2.6
  • le tomcat d'uPortal 2.6 de ce quickstart embarque déjà un jstl-1.1.2.jar dans ses librairies (shared/lib de tomcat) aussi il faut supprimer la librairie esup-filemanager/WEB-INF/lib/jstl-1.2.jar sous peine d'obtenir des exceptions du type javax.servlet.ServletException: javax/el/ELException (la portlet ne fonctionnant alors pas).

Note: esup-filemanager peut fonctionner avec un JDK1.5 même si nous utilisons usuellement un JDK1.6 dans nos tests/développements et déploiements.

Portlet preferences

Lors de la publication de la portlet Esup File Manager dans le portail Esup / uPortal, vous pouvez (re)définir quelques préférences :

  • le choix de la vue ("standard", "wai" ou "mobile") au travers de la préférence defaultPortletView
  • le répertoire à afficher par défaut à l'utilisateur au travers de la préférence "defaultPath" qui sera donnée de la forme "FS:Homedir~UStock". En multi-valuant cette préférence, la portlet affichera en répertoire par défaut le premier de la liste de disponible pour l'utilisateur courant.
  • la préférence contextToken en concordance avec le positionnement de "contextToken" dans drives.xml peut permettre de n'afficher que certains "drives".
  • la préférence showHiddenFiles permet d'afficher ou non les fichiers/répertoires considérés comme "cachés"
  • la préférence useDoubleClick permet d'utiliser ou non le double click lors de la navigation dans la vue standard (Ajax) ; la navigation par double click étant recommandé.
  • la préférence useCursorWaitDialog provoque l'affichage d'une boite de dialogue d'attente entre chaque chargement de pages (vue standard à nouveau).

Une partie de ces préférences peut également être configurée par l'utilisateur lui-même si lors de la publication vous activez le mode Edit.

Sécurité

Rappel : faire fonctionner un ENT "en clair" (http) implique de fait que toutes les informations que l'on rend accessibles ou que l'on saisies dans l'ENT passent en clair, username/password potentiellement saisis dans la portlet Esup File Manager compris. On rappelle aussi que faire fonctionner un ENT en clair implique de faire circuler son cookie de session tomcat JSESSIONID en clair, ce qui peut permettre à un instant t (le temps de la session) une usurpation de session (session d'esup-filemanager comprise) ... cela suivant la sécurité/isolation du réseau utilisé ...

Support de webdav et cifs

esup-filemanager propose des implémentations spécifiques pour ces protocoles (s'appuyant sur les librairies Sardine et JCIFS).

Encodage / URIEncoding

esup-filemanager peut utiliser des requêtes HTTP en passant en paramètre HTTP le nom des répertoires ou fichiers.
En fait il ne le fait maintenant plus (V2 et supérieur) que lors de l'upload de fichiers en utilisant "XHR" : le navigateur fait alors bien un POST, mais le contenu de ce POST contient alors directement le contenu du fichier lui-même, alors que le nom du fichier est passé en paramètre HTTP, c'est à dire codé directement dans l'URL de la forme : "...&qqfile=lenom_du_fichier_qui_peut_avoir_des_accents_héhô.pdf"

esup-filemanager utilise UTF-8 dans l'ensemble de l'application, on considère cela comme une bonne pratique, malheureusement Tomcat utilise par défaut l'ISO-8859-1 pour ce qui concerne l'encodage des url en elles-mêmes.

Aussi, nous vous conseillons de configurer votre Tomcat pour utiliser l'UTF-8 comme encodage des urls.

Pour ce faire, dans votre fichier server.xml, ajoutez dans vos balises Connector l'attribut URIEncoding="UTF-8"

-> Nous estimons que c'est une bonne pratique à généraliser sur vos installations Tomcat.

Plus d'infos ici : http://wiki.apache.org/tomcat/FAQ/CharacterEncoding#Q2

Screenshots

Annexes

Notes pour cassifier rapidement un service SFTP

Montage d'espaces Windows

Récupération et affichage du quota

Remarques et demandes d'évolution

Présentation (Vidéo et Slides) lors de Esup Days n°11 "Nouveau canal stockage"

English page on jasig.org.

Contacts

Merci de vous abonner et d'utiliser la liste mail "esup-utilisateurs" pour nous contacter (problèmes techniques notamment) :

https://listes.esup-portail.org/sympa/info/esup-utilisateurs

Crédits & Licence

Copyright (C) 2012 Esup Portail http://www.esup-portail.org
Copyright (C) 2012 UNR RUNN http://www.unr-runn.fr
Copyright (C) 2012 RECIA http://www.recia.fr
@Author (C) 2012 Vincent Bonamy <Vincent.Bonamy@univ-rouen.fr>
@Contributor (C) 2012 Jean-Pierre Tran <Jean-Pierre.Tran@univ-rouen.fr>
@Contributor (C) 2012 Julien Marchal <Julien.Marchal@univ-nancy2.fr>
@Contributor (C) 2012 Julien Gribonvald <Julien.Gribonvald@recia.fr>
@Contributor (C) 2012 David Clarke <david.clarke@anu.edu.au>
@Contributor (C) 2012 BULL http://www.bull.fr
@Contributor (C) 2012 Pierre Bouvret <pierre.bouvret@u-bordeaux4.fr>
@Contributor (C) 2012 Franck Bordinat <franck.bordinat@univ-jfc.fr>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
        http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Labels
  • None