Copyright © Xerox Corporation, Codendi Team, 2001-2006. All Rights Reserved

3.3 Fonctions du système de gestion des fichiers

Les commandes ci-après peuvent retourner les codes d'erreur suivants:

  • 'invalid_package_fault' (code '3017'): le paquet n'existe pas

  • 'invalid_release_fault' (code '3018'): la version n'existe pas

  • 'invalid_file_fault' (code '3019'): le fichier n'existe pas

3.3.1 getPackages

getPackages: Affiche une liste des paquets disponibles pour un projet

  • --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs getPackages --project=project1
+------------+----------+----------------+-----------+------+-----------------+
| package_id | group_id |      name      | status_id | rank | approve_license |
+------------+----------+----------------+-----------+------+-----------------+
| 198        | 104      | package2       | 1         | 1    |                 |
| 197        | 104      | my_new_package | 1         | 2    |                 |
+------------+----------+----------------+-----------+------+-----------------+
                        

Exemple 29. commande getPackages

3.3.2 addPackage

addPackage: Ajoute un paquet au système de gestion de fichier.

  • --name*: nom du nouveau paquet à ajouter.

  • --status_id: status_id du paquet. Par défaut, le statut est actif.

  • --rank: ordre d'affichage du paquet. Par défaut (si non spécifié), le rang est 0.

  • --approve_license: Si positionné à '1', l'utilisateur final devra approuver une license avant de pouvoir télécharger les fichiers. Sinon, le téléchargement s'effectue directement. Par défaut, la valeur est 1.

  • --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs addPackage --project=project1 --name="my_new_package" --status_id=1
+--------+
| Result |
+--------+
| 197    |
+--------+
                        

Exemple 30. commande addPackage

Note: La valeur retournée (197) est l'identifiant du nouveau paquet créé.

3.3.3 getReleases

getReleases: Affiche une liste des versions disponibles pour un projet et un paquet donné.

  • --package_id*: l'identifiant du paquet

  • --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs getReleases --project=project1 --package_id=197
+------------+------------+---------------+--------------------------------+---------------------------...
| release_id | package_id |     name      |             notes              |             changes       ...
+------------+------------+---------------+--------------------------------+---------------------------...
| 144        | 197        | first version | somes notes about this release | first release             ...
| 143        | 197        | new version   | somes notes about this release | the changes of this new re...
+------------+------------+---------------+--------------------------------+---------------------------...
                        

Exemple 31. commande getReleases

3.3.4 addRelease

addRelease: Ajoute une version au système de gestion des fichiers.

  • --package_id*: l'identifiant du paquet qui contiendra la nouvelle version

  • --name*: nom de la nouvelle version à créer.

  • --notes: notes à propos de la nouvelle version

  • --changes: changements de cette nouvelle version

  • --status_id: status_id de la nouvelle version. Par défaut (si non spécifié), le statut est actif.

  • --release_date: date de la nouvelle version, au format YYYY-MM-DD. Par défaut, la date de la version est la date courante.

  • --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs addRelease --package_id=197 --name="new version" --notes="somes notes about this release" --changes="the changes of this new release" --status_id=1
+--------+
| Result |
+--------+
| 143    |
+--------+
                        

Exemple 32. commande addRelease

Note: La valeur retournée (143) est l'identifiant de la nouvelle version créée.

3.3.5 getFiles

getFiles: Affiche une liste des fichiers disponibles pour un projet, un paquet et une version donnée.

  • --package_id*: l'identifiant du paquet

  • --release_id*: l'identifiant de la version

  • --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs getFiles --package_id=197 --release_id=143
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
| file_id | release_id |    file_name    | file_size | type_id | processor_id | release_time | post_dat...
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
| 419     | 143        | p197_r143/file1 | 14        | 9999    | 9999         | 1293787567   | 12937875...
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
                        

Exemple 33. commande getFiles

3.3.6 addFile

Support des gros fichiers: CLI peut ajouter des fichiers supérieurs à 2Go lorsque que la machine cliente (qui exécute CLI) et le serveur sont des machines 64 bits. Dans les autres cas, pour ajouter des fichiers > à 2Go, il faut utiliser FTP pour le transfert et l'option --uploaded_file.

addFile: Ajoute un fichier au système de gestion des fichiers

  • --package_id*: identifiant du paquet qui contiendra le fichier

  • --release_id*: identifiant de la version qui contiendra le fichier

  • --local_file(*): emplacement (local) du fichier à ajouter. Utilisez cet argument si votre fichier est local. Votre fichier sera téléchargé sur le serveur. Au moins un des arguments --local_file ou --uploaded_file est obligatoire, selon la méthode utilisée pour ajouter votre fichier.

  • --uploaded_file(*): nom du fichier à ajouter. Le fichier doit déjà se trouver dans le répertoire "incoming" du serveur. Au moins un des arguments --local_file ou --uploaded_file est obligatoire, selon la méthode utilisée pour ajouter votre fichier.

  • --type_id: type_id du fichier

  • --processor_id: processor_id du fichier

  • --reference_md5: Le md5 du fichier se trouvant dans le répertoire "incoming" du serveur.

  • --comment: Un commentaire pour le nouveau fichier

  • --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

Pour un fichier local le md5sum est automatiquement calculé par CLI dans la machine cliente, alors le paramètre reference_md5 n'est pris en considération que pour les fichiers uploadés dans "incoming" en utilisant ftp et il est absolument inutile de l'ajouter pour un fichier local.

[ounis@linux tuleap-cli]$ ./tuleap.php frs addFile --package_id=197 --release_id=143 --local_file=file1
+--------+
| Result |
+--------+
| 419    |
+--------+

(pour un fichier local ou)

[ounis@linux tuleap-cli]$ ./tuleap.php frs addFile --package_id=197 --release_id=143 --uploaded_file=file2
+--------+
| Result |
+--------+
| 420    |
+--------+

(pour un fichier déjà téléchargé dans le répertoire incoming de votre serveur)
                        

Exemple 34. commande addFile

Note: La valeur retournée (420) est l'identifiant du nouveau fichier créé.

3.3.7 getFile

Support des gros fichiers: CLI peut télécharger des fichiers supérieurs à 2Go lorsque que la machine cliente (qui exécute CLI) et le serveur sont des machines 64 bits.

getFile: Retourne le contenu du fichier

  • --package_id* : identifiant du paquet dans lequel se trouve le fichier

  • --release_id* : identifiant de la version dans laquelle se trouve le fichier

  • --file_id* : identifiant du fichier à retourner

  • --output : emplacement où télécharger le fichier. Si non spécifié, le contenu du fichier sera affiché sur la sortie standard.

  • --remote_name: Pour retrouver le nom de fichier depuis le serveur au lieu d'utiliser --output.

  • --project : nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs getFile --package_id=197 --release_id=143 --file_id=419 --output=./downloaded_file
File retrieved successfully.
                        

Exemple 35. commande getFile

Note : si aucune erreur n'est retournée, le fichier est correctement téléchargé.

3.3.8 getUploadedFiles

getUploadedFiles: Affiche une liste des fichiers uploadés avec ftp dans le répértoire incoming

  • --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs getUploadedFiles
+--------+
| Result |
+--------+
| file1  |
| file2  |
+--------+
                        

Exemple 36. getUploadedFiles command

3.3.9 deleteFile

deleteFile: Supprime un fichier

  • --package_id*: identifiant du paquet dans lequel se trouve le fichier

  • --release_id*: identifiant de la version dans laquelle se trouve le fichier

  • --file_id*: identifiant du fichier à supprimer

  • --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteFile --package_id=197 --release_id=143 --file_id=420
+--------+
| Result |
+--------+
| 1      |
+--------+
                        

Exemple 37. deleteFile command

Note : la valeur retournée 1 indique que la suppression a été effectuée. Dans tous les autres cas, une erreur est retournée.

3.3.10 getFileInfo

getFileInfo: Affiche les informations relatives a un fichier donné.

  • --package_id*: identifiant du paquet dans lequel se trouve le fichier

  • --release_id*: identifiant de la version dans laquelle se trouve le fichier

  • --file_id*: identifiant du fichier dont on veut afficher les informations

  • --project: nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs getFileInfo --package_id=197 --release_id=143 --file_id=419
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
| file_id | release_id |    file_name    | file_size | type_id | processor_id | release_time | post_dat...
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
| 419     | 143        | p197_r143/file1 | 14        | 9999    | 9999         | 1293787567   | 12937875...
+---------+------------+-----------------+-----------+---------+--------------+--------------+---------...
                        

Exemple 38. getFileInfo command

3.3.11 deleteEmptyPackage

deleteEmptyPackage: Supprime le paquet s'il est vide

  • --project: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

  • --package_id*: Identifiant du paquet à supprimer.

[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteEmptyPackage --package_id=288
+------------+----------+------+-----------+------+-----------------+
| package_id | group_id | name | status_id | rank | approve_license |
+------------+----------+------+-----------+------+-----------------+
| 288        | 104      | test | 1         | 5    |                 |
+------------+----------+------+-----------+------+-----------------+
                        

Exemple 39. commande deleteEmptyPackage

La valeur de retour représente les détails du paquet supprimé.

3.3.12 deleteAllEmptyPackages

deleteAllEmptyPackages: Supprime tous les paquets vides du projet

  • --project: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteAllEmptyPackages
+------------+----------+------+-----------+------+-----------------+
| package_id | group_id | name | status_id | rank | approve_license |
+------------+----------+------+-----------+------+-----------------+
| 288        | 104      | test | 1         | 5    |                 |
| 226        | 104      | pkg  | 1         | 6    |                 |
+------------+----------+------+-----------+------+-----------------+
                        

Exemple 40. commande deleteAllEmptyPackages

La valeur de retour est la liste des paquets supprimés.

3.3.13 deleteEmptyRelease

deleteEmptyRelease: Supprime la version si elle est vide.

  • --project: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

  • --package_id*: Id du paquet dans lequel les versions vides seront supprimées

  • --release_id*: Identifiant de la version à supprimer.

[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteEmptyRelease --package_id=288 --release_id=226
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
| release_id | package_id |     name      | notes | changes | status_id | release_date | released_by |
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
| 226        | 288        | empty release |       |         | 1         | 1323648000   | 103         |
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
                        

Exemple 41. commande deleteEmptyRelease

La valeur de retour représente les détails de la version supprimée.

3.3.14 deleteAllEmptyReleases

deleteAllEmptyReleases: Supprime toutes les versions vides du paquet

  • --project: Nom UNIX du projet. Si vous ne le spécifiez pas, le projet spécifié lors de la connexion sera utilisé. Si aucun projet n'a été spécifié lors du login, une erreur sera affichée.

  • --package_id*: Id du paquet dans lequel les versions vides seront supprimées

[ounis@linux tuleap-cli]$ ./tuleap.php frs deleteAllEmptyReleases --package_id=288
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
| release_id | package_id |     name      | notes | changes | status_id | release_date | released_by |
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
| 226        | 288        | empty release |       |         | 1         | 1323648000   | 103         |
| 224        | 288        | empty         |       |         | 1         | 1323648000   | 103         |
+------------+------------+---------------+-------+---------+-----------+--------------+-------------+
                        

Exemple 42. commande deleteAllEmptyReleases

La valeur de retour est la liste des versions supprimées.


Copyright © Xerox Corporation, Codendi Team, 2001-2006. All Rights Reserved