Club Drupal

{{important(Si vous *modifiez les fichiers de configuration de drush*, pensez à vider les caches avec _drush cache-clear drush_)}}

{{>toc}}

h1. C'est quoi ?

Drush signifie _drupal shell_. C'est un utilitaire disponible sur nos installations afin d'administrer nos sites en ligne de commande.

Pour avoir la liste des commandes les plus simples, taper drush dans un terminal, ou consulter cette http://drupal.org/node/477684.

Pour effectuer une action, il faut au préalable se placer dans le dossier du site concerné, puis taper la commande drush.

h1. Quelques exemples simples

* activer le module ou le thème nommé projet : <code>drush en projet</code>

* désactiver le module ou le thème nommé projet <code>drush dis projet </code>

* lister les modules et les thèmes, leurs statuts (activé, désactivé, pas installé), et leurs versions <code>drush pml </code>

* désinstaller le module ou le thème nommé projet <code>drush pm-uninstall projet </code>

**Rappel :** désinstaller un projet = le désactiver + supprimer les tables de ce projet dans la base de données

* récupérer la valeur actuelle de la variable nommée ma_variable <code>drush vget ma_variable </code>

* modifier la valeur de _ma_variable_ en _nvelle_valeur_ <code>drush vset ma_variable nvelle_valeur </code>

NB : une variable est un champ de la table monsite_variables (dans la base de données).

On peut citer par exemple _theme_default_ le thème par défaut du site ou _admin_theme_ le thème de l'administration.

* vider tous les caches <code>drush cc all</code> 

h1. Gérer les utilisateurs

h2. Savoir qui administre un site

**À partir de drupal 7**

Cette commande permet de chercher dans la base de données les utilisateurs qui ont le _rid_ numéro 3 (qui correspond au rôle d'administrateur (toujours) dans D7 à moins d'aller exprès dans la bdd le changer !)

<pre>

<code>

drush sqlq  "SELECT name, mail FROM users WHERE uid IN (SELECT uid FROM users_roles WHERE rid=3);"

</code>

</pre>

Si le site à un préfix (en cours de disparition) :

<pre>

<code>

drush sqlq  "SELECT name, mail FROM nomdusite_users WHERE uid IN (SELECT uid FROM nomdusite_users_roles WHERE rid=3);"

</code>

</pre>

h2. Obtenir des informations sur un utilisateur

Retourne, pour un login donné, l'uid, l'adresse mail, les rôles et le statut.

<pre>

<code>drush uinf mon_utilisateur</code>

</pre>

h2. Changer le mot de passe d'un utilisateur

Uniquement si problème de passation au niveau de l'administration d'un site, et sur demande explicite de celui-ci.

<pre>

<code>

drush upwd mon_utilisateur --password="mon_nvo_mot-de-passe"

</code>

</pre>

h2. Changer les rôles d'un utilisateur

Idem, uniquement sur demande explicite de celui-ci !

* <code> drush urol "administrator" mon_utilisateur  </code> : donne le rôle "administrator" à l'utilisateur mon_utilisateur

* <code> drush urrol "administrator" mon_utilisateur  </code> : retire le rôle "administrator" à l'utilisateur mon_utilisateur

Pour devenir temporairement administrateur sur un site ou permettre à l’utilisateur d’id 1 de changer son mot de passe : <code>drush uli</code>. Cette commande retourne un lien à copier/coller dans son navigateur.

h1. Manipulation des bases de données

h2. Sauvegarder une base de données

Pour les sites drupal 6, utiliser le script @dump_site NOM_DU_SITE@.

Pour les sites drupal 7 qui sont dans leur base de données, utiliser la commande @drush sql-dump --result-file="FICHIER"@. Par défaut, cette commande affiche la base de données dans le terminal.

h2. Revenir sur une mise à jour qui a échoué

Pour revenir sur une mise à jour, il faut rétablir la base de données telle qu'elle était avant la mise à jour.

Cela suppose évidemment d'avoir fait une sauvegarde de la base de donnée avant :p

Dans le cas d'une grosse base de données comme la notre, phpmyadmin n'est pas une solution viable, il faut donc utiliser directement le sql en ligne de commande ou drush, bien entendu ^^

<pre>

<code>

drush sqlq < ~/sauvegardes/12345.sql

</code>

</pre>

C'est l'équivalent sql de :

<pre>

<code>

 mysql -h localhost -u root -p mabase < ~/sauvegardes/12345.sql 

</code>

</pre>

Explications : je me connecte au serveur _localhost_ avec le nom d'utilisateur _root_ et je veux écraser la base de donnée _mabase_ en y injectant le code sql généré par ma sauvegarde dans le fichier ~/sauvegardes/12345.sql

NB : Pour écraser une base, assurez-vous d'avoir des "CREATE TABLE IF NOT EXISTS" dans le fichier de sauvegardes et non seulement "CREATE TABLE". Dans ce dernier cas, il faut supprimer les tables de la bdd avant d'injecter les fichiers sql.

h1. Les alias drush

h2. Les alias de sites

h3. Généralités

Les alias de sites permettent de lancer une commande @drush@ sans être dans le dossier du site, en précisant le nom du site via un alias de la manière suivante :

<pre>

<code>

drush @monsite status

</code>

</pre>

Pour connaître la liste de tous les alias et leur syntaxe exacte, lancer <code>drush sa</code> dans le dossier des sites.

NB : l'alias <code>drush @sites</code> permet de lancer la commande drush sur chacun des sites, et effectue une action similaire à [[Scripts_et_taches_planifiees#drushall_and_co|notre script drushall]] sans pour autant le remplacer…

h3. Mettre en place ses alias de script pour des sites locaux

@drush@ crée dans le répertoire de l’utilisateur un dossier @.drush@ qui contient les fichiers de configuration de _drush_. Pour activer les alias drush, créer dans ce dossier un fichier aliases.drushrc.php et placez-y les instructions suivantes (à adapter à votre configuration) :

<pre>

<code class="php">

<?php

$aliases['toto'] = array(

'uri' => 'toto.local',

'root' => '/var/www/local',

);

</code>

</pre>

Vous pouvez désormais appliquer une commande sur toto en utilisant <code>drush @toto CMD</code>.

h3. Mettre en place ses alias de script pour des sites distants

Marre de devoir vous connecter sur la machine où votre drupal est installé ? Alors les alias distants sont fait pour vous. Il vous permette depuis votre machine local d’administrer les sites installés sur une autre machine. Utiliser une clé ssh semble tout à fait adapter pour ne pas avoir à taper le mot de passe tout le temps. Pour cela, dans le fichier ~/.drush/aliases.drushrc.php entrer le code suivant (donné en exemple pour assos) :

<pre>

<code class="php">

$aliases['sitedistant'] = array(

'uri' => 'assos.centrale-marseille.fr',

'root' => '/users/guest/assos/htmltest',

'remote-user' => 'assos',

'remote-host' => 'sas1.centrale-marseille.fr',

);

</code>

</pre>

{{important(Il ne faut surtout pas mettre le chemin du dossier du site avec la clé _root_, sinon les commandes drush distantes ne fonctionnent pas (même si c’est tentant car facilite la synchronisation des fichiers))}}

h2. Les alias de scripts

{{warning(*À ne plus utiliser :* il a été décidé de ne plus passer par les alias de scripts mais de faire des scripts à la place afin d'uniformiser la manière d'entretenir l'installation multi-assos. Les alias de script du club drupal ont donc été abandonnés.)}}

Il est également possible de créer des commandes drush personnalisées en utilisant les alias. On peut alors regrouper plusieurs actions souvent effectuées à la suite, voire même des scripts entiers, dans une commande drush.

h1. Les commandes pour dupliquer un site

Drush est tout à fait capable de répliquer un site distant sur votre machine ou un site local sur une machine distante. *Il faut avoir paramétré les alias drush avant*. Pour cela, il suffit d’utiliser les commandes suivantes :

* <code>drush -y rsync @${site}2:%files @${site}:%files</code> pour synchroniser les fichiers. Visiblement tenter de synchroniser autre chose (l’arbre complet par exemple) n’est pas possible. Il est préférable d’utiliser du rsync classique. Si vous synchroniser sur un site local, les fichiers seront bien dans _sites_ mais le dossier s’appellera %files. Si le % est omis, les fichiers seront dans _sites/files/files_.

* <code>drush -y sql-sync  @${site}2 @${site}</code> pour dupliquer la base de données.

h1. Agir sur tous les sites d'un coup

Pour administrer tous les sites du multi-site en une seule fois, nous avons créé le script [[Scripts_et_taches_planifiees#d7-all-drushsh|d7-all-drush.sh]].

h1. Commandes Drush diverses

<pre>

<code>

drush pml | grep "^ Core" -v | grep "Enabled" | wc -l

</code>

</pre>

Pour compter le nombre de modules non-core activés.

h1. Plus de commandes Drush

* http://drush.ws/

* http://www.drushcommands.com/