Preparant l'entorn de desenvolupament

De Guifi.net - Wiki Català

Introducció

Aquest document té com finalitat documentar alguns consells sobre com preparar un entorn de desenvolupament per col·laborar en el desenvolupament de la web de guifi.net. Ens centrarem al mòdul "drupal-guifi", que és el pilar fonamental de tota la gestió de la web de guifi.net, però l'entorn muntat pot fer-se servir per desenvolupar altres mòduls o temes, com per exemple "theme_guifinet2011".

Instalació de serveis

Per a fer funcionar Drupal a la màquina de desenvolupament cal posar en marxa un servidor web, el mòdul PHP pel servidor web i un servidor de base de dades (MySQL).

En funció del nostre sistema operatiu i les nostres preferències, la instalació d'aquests serveis es realitzarà d'una manera o d'una altra. A continuació es detalla pels entorns Debian/Ubuntu amb Apache+PHP+Mysql i Archlinux amb Nginx+PHP+Mysql. Totes dues instalacions són simples.

  • Debian/Ubuntu: 
$ sudo apt-get install mysql-server libapache2-mod-php5 php5-gd php5-mysql
  • Archlinux: 
$ pacman -S nginx mysql php-fpm php-gd

Documentació per a Archlinux: Apache, PHP and MySQL, Nginx

La configuració del servidor web (Apache/lighttpd/nginx) per a fer que funcioni el mòdul de PHP a l'arrel del nostre directori web depèn del nostre sistema. A Google podeu trobar tutorials si no teniu clar com fer-lo. Si en trobeu un d'interessant, si us plau, enllaçeu-lo a aquest document.

Configuració de php.ini

Hem de tenir activats els següents mòduls a l'arxiu php.ini: 

extension=mysql.so
extension=iconv.so
extension=gd.so

Ara heu de testejar si el vostre sistema interpreta arxius PHP. Aquí teniu un exemple que podeu crear al DOCUMENT_ROOT (generalment /var/www) del vostre servidor web. Si no us funciona reviseu els passos anteriors i consulteu la documentació de la vostra distribució. 

<?php
phpinfo();
?>

Configuració de fitxers Per tal de no tenir problemes en la nostra instal·lació de l'entorn de desenvolupament, es necessari realitzar algunes modificacions dins d'uns fitxers concrets els quals esmentarem per tal de que tot funcioni correctament:

En l'adreça següent: /etc/apache2/sites-enabled/

Hi tenim un únic fitxer el qual es diu '000-default'. Bé, mitjançant un editor de text de shell (com pot ser el vi) editarem el fitxer:

$ vi 000-default

Dins del fitxer, hem de buscar el següent text: 'Allow Override None' en tot el text i substituir-lo per 'Allow Override All'. Per realitzar la modificació, mitjançant les fletxes de direcció ens situarem sobre la línia en qüestió i apretarem la tecla 'i' la qual ens permetrà escriure. Si es presenten problemes, sembre es pot sortir del fitxer sense desar mitjançant la tecla 'ESC' seguit de la comanda ':q!' <quit without saving> << sortir sense guardar.

La nostra web amb drupal necessita fer servir Clean URL i per tal de que aquestes es puguin aplicar es necessari tenir activat el mòdul rewrite. Per tal d'activar aquest mòdul, utilitzarem les comandes següents:

$a2enmod rewrite

Ens informarà que el mòdul està actiu i que s'haurà de reiniciar el servei, cosa que farem amb la comanda:

$ /etc/init.d/apache2 restart o bé $ service apache2 restart

Descarregant el codi font

El codi dels mòduls "drupal-guifi", "drupal-bugdets" i "theme_guifinet2011" son software lliure, i estan allotjats als repositoris de Gitorious. Els repositoris son útils per desenvolupament de programari però nosaltres ens limitarem a clonar-los.

Requisits pel clonatge del repositori drupal-guifi

Viam cóm deuríem procedir per a fer un fork del projecte "drupal-guifi" de cara a realitzar alguna modificació sobre el seu codi font.

  • Crear-se una compta a Gitorious.
  • Crear unes claus SSH (ssh-keygen) sense contrasenya, i afegir-las al nostre perfil d'usuari de gitorious. Per exemple: 
$ ssh-keygen 
Generating public/private rsa key pair.
Enter file in which to save the key (/home/dave/.ssh/id_rsa): 
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved in /home/dave/.ssh/id_rsa.
Your public key has been saved in /home/dave/.ssh/id_rsa.pub.
  • Accedir a la pàgina del projecte "drupal-guifi".
  • Clonar el projecte. Amb això ja tindrem un fork del projecte sobre el que podem realitzar els nostres canvis.


Pàginas web a Gitorious dels projectes amb els que anem a treballar:

Descarrega, instalació i configuració d'un entorn Drupal

Ara que ja tenim els serveis necesaris instal·lats a la nostra màquina de desenvolupament i sabem cóm clonar els repositoris de codi font amb els que volem treballar, anem a procedir a tenir funcionant a aquesta màquina un Drupal 6.x (amb alguns mòduls adicionals), ja que així podrem veure i testejar els canvis que anem fent al nostre repositori de "drupal-guifi".

Descàrregues

  • La darrera versió de Drupal 6.x desde linea de comandes 
 wget http://ftp.drupal.org/files/projects/drupal-6.29.tar.gz

i habilitar l'accès via web: 

ln -s /usr/share/drupal6/ /var/www/guifi
  • Mòduls de Drupal fonamentals per al nostre entorn drupal : webform, views, i18n, views_slideshow
  • Mòduls de Drupal opcionals: schema, devel, potx, l10n_client, languageicons, language_sections, diff, captcha, captcha_pack, event, cck, fckeditor, image, image_filter
  • Mòduls desenvolupats per la comunitat Guifi.net: budgets, guifi
  • El tema oficial "theme_guifinet2011"
  • La base de dades actual de desenvolupament de la web de guifi.net: 
$ wget http://www.guifi.net/guifi66_devel.sql.gz

Instalació de Drupal

Anem a posar en marxa un entorn Drupal bàsic i posteriorment sobreescriurem la base de dades amb la que hem descarregat previament de Guifi.net.

Aquests son els passos bàsics per a instal·lar i configurar un site Drupal:

  • Descomprimim el paquet de Drupal que ens hem descarregat i el posem accesible al DOCUMENT_ROOT d'Apache: 
$ cd /var/www
$ tar zxvf drupal-6.29.tar.gz
$ ln -s drupal-6.29 guifi
  • Iniciem el procés de instalació via web de Drupal accedint a http://<ip_del_teu_servidor>/guifi

exemples:

http://10.138.71.10/guifi http://localhost/guifi

  • En arribar a l'apartat de configuració de la base de dades, necessitarem tenir creada una base de dades local de MySQL per a desenvolupament: 
[dave@inuik http]$ mysql -u <nomusuari> -p <contrassenya> << es possible 
 que amb root no fagi falta una password

exemple: $ mysql -u root -p <salt de linia> Enter password: <escritura_de_la_password>

Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL connection id is 525 Server version: 5.5.31-0+wheezy1 (Debian)

Copyright (c) 2000,2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. 

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> create database guifi_test;
Query OK, 1 row affected (0.00 sec)

mysql> grant all on guifi_test.* to guifi@localhost identified by 'guifinet';
Query OK, 0 rows affected (0.00 sec)

Ja podem introduir la informació de connexió a la base de dades per a que Drupal cregui les tables necessàries.

Instalació dels mòduls de Drupal necessaris per a arrencar l'entorn

Descarregar els mòduls absolutament necessaris per a arrencar el nostre site de Guifi.net

ATENCIÓ. Fixeu-vos que el mòdul "drupal-guifi" que estem clonant no es el repositori principal sino el que hem creat fent un fork del projecte principal. Així els canvis que fem els podrem pujar a Gitorious, per a posteriorment, si considerem convenient, notificar als desenvolupadors principals per que els integrin a la branca principal de desenvolupament (merge request). 

$ mkdir drupal-6.29/sites/all/modules
$ cd drupal-6.29/sites/all/modules
$ git clone git://gitorious.org/guifi/drupal-budgets.git budgets
$ # Clonat de MI FORK del mòdul "drupal-guifi" 
$ git clone git@gitorious.org:~tombatossals/guifi/tombatossalss-drupal-guifi.git guifi (canvia "~tombatossals/guifi/tombatossalss-drupal-guifi.git" pel teu repositori clonat )

És possible (degut a que a mi m'ha passat) que al executar les comandes per a la decàrrega de mòduls el sistema fagi de tot menys el que toca. De ser així, es poden realitzar les comandes sense les opcions '-q' i '-O'.

Mòdul WebForm: 

$ wget -q -O - http://ftp.drupal.org/files/projects/webform-6.x-3.19.tar.gz 
o
$ wget http://ftp.drupal.org/files/projects/webform-6.x-3.19.tar.gz

Mòdul Views: 

$ wget -q -O - http://ftp.drupal.org/files/projects/views-6.x-2.16.tar.gz

o 

$ wget http://ftp.drupal.org/files/projects/views-6.x-2.16.tar.gz

Mòdul Views_slideshow: 

$ wget -q -O - http://ftp.drupal.org/files/projects/views_slideshow-6.x-2.4.tar.gz

o 

$ wget http://ftp.drupal.org/files/projects/views_slideshow-6.x-2.4.tar.gz

Mòdul i18n <Multi-idioma>: 

$ wget -q -O - http://ftp.drupal.org/files/projects/i18n-6.x-1.10.tar.gz

o 

$ wget http://ftp.drupal.org/files/projects/i18n-6.x-1.10.tar.gz

Dins de l'adreça /var/www/drupal-6.29/sites/all/modules, on tindrem descarregats els nostres mòduls, els descomprimirem mitjançant la ordre: 

$ tar zxvf <nom_del_fitxer_a_descomprimir>
$ tar zxvf i18n-6.x-1.10.tar.gz

Instalació de la base de dades de desenvolupament de Guifi.net

Ja tenim una instalació neta de Drupal, almenys en teoria. Ara anem a sobreescriure la base de dades amb la informació de tables de la base de dades de Guifi.net, el que ens proporcionarà un entorn de desenvolupament similar a la web en producció. Anem a això: 

$ mysql -u root guifi_test < guifi66_devel.sql; << recordem que 
  les comandes dins de MySQL s'acaben amb un ';'

== Afinant la instalació ==

Un cop realitzada la instal·lació, s'ha d'editar el fitxer .htaccess, que es troba dins de la carpeta arrel de drupal : 

$ cd /var/www/drupal-6.29
$ ls -la << per mostrar llistats tots els fitxers inclosos els ocults

Ens mostrarà un arxiu ocult anomenat : .htaccess L'editarem mitjançant un editor de text: 

$ vi .htaccess

En una linia buida del fitxer, apretarem la 'i' per escriure-hi i afegirem la següent linia: RewriteBase /drupal-6.29


Un cop instalada la base de dades amb tota la informació de la web de Guifi.net, tindrem accés a la informació de qualsevol node o zona de la web principal. Per a loguejar-te com usuari, has de fer servir el nom d'usuari corresponent i la contrasenya genèrica "guifi".

L'usuari administrador serà "webmestre" i la contrasenya "guifi".

Alguns consells per a refinar la instalació:

  • Creeu i comproveu que els directoris "files", "files/nanostation" i "tmp" del directori de instalació de drupal tenen permisos de escriptura per l'usuari del servidor web (o poseu-los a 777): 
$ mkdir drupal-6.29/{files,files/nanostation,tmp}
$ chmod 777 drupal-6.29/{files,files/nanostation,tmp}
  • La carpeta "files/nanostation" contendrà els arxius "unsolclic" de les antenes Ubiquiti que anem consultant o creant.
  • Protegiu la carpeta "files" i "tmp" amb el seu respectiu fixter .htaccess

A la carpeta "files" el ftixer .htaccess ha de incloure aquest contingut: 

# Turn off all options we don't need.
Options None
Options +FollowSymLinks
# Set the catch-all handler to prevent scripts from being executed.
SetHandler Drupal_Security_Do_Not_Remove_See_SA_2006_006
<Files *>
  # Override the handler again if we're run later in the evaluation list.
  SetHandler Drupal_Security_Do_Not_Remove_See_SA_2013_003
</Files>
# If we know how to do it safely, disable the PHP engine entirely.
<IfModule mod_php5.c>
  php_flag engine off
</IfModule>
# PHP 4, Apache 1.
<IfModule mod_php4.c>
  php_flag engine off
</IfModule>
# PHP 4, Apache 2.
<IfModule sapi_apache2.c>
  php_flag engine off
</IfModule>

I a la carpeta "tmp", el fitxer .htaccess ha de ser exactament el mateix que el de "files" pero hi hem d'afegir al final de tot això: 

Deny from all
  • Editeu el fitxer robots.txt, elimineu-ne tot el contingut i afegiu únicament aquestes linies, doncs no ens interessa que els robots indexin el nostre entorn local. 
User-agent: *
Disallow: /


  • Accediu a la secció de configuració de "Performance" y deshabiliteu tot l'usatge de caché, optimització y compressió. Ens interessa que els canvis que fem sobre els arxius s'actualitzin en temps real. La URL d'accés a aquesta configuració serà de l'estil de: http://localhost/guifi/admin/settings/performance

Instalació del tema Guifi.net al Drupal

$ mkdir drupal-6.29/sites/all/themes
$ cd drupal-6.29/sites/all/themes
$ git clone git://gitorious.org/guifi-web/theme_guifinet2011.git

El tema no s'activarà inmediatament, ja que li mancaran els arxius d'estils que Drupal creu que esten cachejats al sistema. Per a aconseguir que el tema s'activi completament, haurem d'accedir a l'"administració de temes", "configuració del tema de guifinet2011" i "desar" sense tocar cap opció. El tema per fi estarà activat.

Instalació dels idiomes

La base de dades de Guifi.net que hem importat té habilitats varis idiomes per defecte, però les traduccions no estén instalades al sistema. Per a solucionarlo, seguim aquests passos:

Per exemple: http://ftp.drupal.org/files/translations/6.x/drupal/drupal-6.29.ca.po

  • Aneu a la administració de idiomes de la vostra instalació com webmestre, està localitzada a /admin/settings/language, i fixeu-vos que hi ha un enllaç per a importació manual dels strings de traducció: /admin/build/translate/import
  • Indiqueu-li l'idioma de l'arxiu que heu descarregat e importeu-lo. A partir d'aquí ja tindrem l'interfície traduïda.

Començant a treballar

Ja tenim un entorn preparat per començar a modificar els mòduls de Drupal, pujar-los al nostre propi repositori i, si lo considerem convenient, notificar els nostres commits als desenvolupadors per a que els integrin a la branca principal.

Per a fer commit dels nostres canvis: 

$ cd drupal-6.29/site/all/modules/drupal-guifi
$ # Fem modificacions a alguns arxius, les enregistrem al nostre repositori i procedirem a pujar-les a gitorious
$ git commit -a
$ git push

Posteriorment, des de la web de Gitorious podrem fer servir un "Merge request" per notificar als desenvolupadors alguna de les nostres modificacions i que valorin la seva incorporació al repositori principal.

Actualitzant el nostre repositori amb els canvis del repositori pare

Si volem mantenir el nostre repositori actualitzat amb els darrers canvis que es van produint al repositori pare, haurem de seguir la següent recepta: 

# Definim com repositori remot anomenat "upstream" el repositori de "drupal-guifi"
$ git remote add upstream git://gitorious.org/guifi/drupal-guifi.git

# Obtenim els darrers canvis del nostre repositori
$ git fetch origin -v

# Obtenim els darrers canvis del repositori pare
$ git fetch upstream -v

# Fem el merge dels canvis obtinguts
$ git merge upstream/master

Referències

Aquest article conté informació extreta d'aquest fil de la llista de correu de webdev.

Enllaços externs

Obtingut de «http://ca.wiki.guifi.net/w/index.php?title=Preparant_l%27entorn_de_desenvolupament&oldid=3541»
Eines de l'usuari