Preparando el entorno de desarrollo

De Guifi.net - Wiki Hispano

Introducción

Este documento tiene como propósito documentar algunos consejos sobre cómo adecuar un entorno de desarrollo para colaborar en el desarrollo de la web de guifi.net. Nos centraremos en el módulo "drupal-guifi", que es el pilar fundamental de toda la gestión de la web de guifi.net, ya que es el que yo estoy utilizando, pero el entorno montado puede utilizarse también para desarrollar otros módulos o temas, como por ejemplo "theme_guifinet2011". Cada usuario es perfectamente libre de seguir las pautas aquí indicadas, o de utilizar las suyas propias y utilizar este documento únicamente como referencia básica. Vamos a ello.

Instalación de servicios

Para hacer funcionar Drupal en nuestra máquina es fundamental arrancar un servidor web, el módulo PHP para el servidor web, y un servidor de base de datos (MySQL).

Dependiendo de nuestro sistema operativo y nuestras preferencias, la instalación de estos servicios se realizará de una manera u otra. En entornos Debian/Ubuntu es realmente sencillo instalar Apache+PHP+Mysql, yo actualmente trabajo en un entorno Archlinux y utilizo como servidor web Nginx+PHP+Mysql y la instalación es también bastante simple.

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

Documentación para Archlinux: https://wiki.archlinux.org/index.php/Apache,_PHP,_and_MySQL, https://wiki.archlinux.org/index.php/Nginx

La configuración del servidor web (Apache/lighttpd/nginx) para hacer que funcione el módulo de PHP en la raiz de nuestro directorio web depende de nuestro sistema, así que busca un tutorial por Google (existen varios) si no tienes claro cómo hacerlo. Si encuentras uno bueno, por favor, enlázalo en este documento.

Configuración de php.ini

Simplemente comentar que debemos tener activados los siguientes módulos en el archivo php.ini:

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

Si has conseguido que tu sistema interprete un archivo PHP como el del ejemplo de abajo, en el DOCUMENT_ROOT de tu sistema, enhorabuena, puedes continuar con siguiente punto del documento.

<?php
phpinfo();
?>

Phpinfo01.png

Descargando el código fuente

El código del módulo "drupal-guifi", "drupal-bugdets", o "theme_guifinet2011" es open-source, y está alojado en los servidores de gitorious, lo que nos facilitará el clonado, desarrollo e integración de nuestras modificaciones sobre estos módulos con la rama principal.

Requisitos para el clonado del repositorio drupal-guifi

Veamos como deberíamos proceder para hacer un fork del proyecto "drupal-guifi" de cara a realizar alguna modificación sobre su código fuente.

  • Crearse una cuenta en gitorious.
  • Acceder a la página del proyecto "drupal-guifi".
  • Clonar el proyecto. Con eso ya tenemos un fork del proyecto sobre el que podemos realizar nuestros cambios.
  • Crear unas llaves SSH (ssh-keygen) sin contraseña, y añadirlas en nuestro perfil de usuario de gitorious. Por ejemplo:
$ 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.

Gitorious001.png

Páginas web en gitorious de los proyectos con los que vamos a trabajar:

Descarga, instalación y configuración de un entorno Drupal

Ahora que ya tenemos los servicios necesarios instalados en nuestra máquina de desarrollo, y sabemos como clonar el repositorio de código fuente con el que queremos trabajar, vamos a proceder a tener funcionando en nuestra máquina un drupal 6.x operativo (con varios módulos adicionales), ya que así podremos ver y testear los cambios que vamos haciendo a nuestro repositorio de "drupal-guifi".

Descargas

  • La última versión de Drupal 6.x, actualmente la 6.22, desde su página oficial
$ wget http://ftp.drupal.org/files/projects/drupal-6.22.tar.gz
  • Los siguientes módulos de drupal son fundamentales: webform, views.
  • Los siguiente módulos de drupal son opcionales: schema, devel, potx, i18n, l10n_client, languageicons, language_sections, diff, captcha, captcha_pack, event, views_slideshow, cck, fckeditor, image, image_filter.
  • Los siguientes módulos desarrollados en el proyecto guifi.net: budgets, guifi (luego veremos como clonar el repositorio git de estos módulos).
  • El tema oficial "theme_guifinet2011" (luego veremos como clonar el repositorio git de este tema).
  • La base de datos actual de desarrollo de la web de guifi.net:
$ wget http://www.guifi.net/guifi66_devel.sql.gz

Instalación de drupal

Vamos a poner en marcha un entorno Drupal básico, que posteriormente sobreescribiremos con la base de datos de guifi que hemos descargado previamente.

Hay muchos tutoriales por internet que explican como instalar y configurar un site drupal, veamos aquí los pasos básicos para conseguirlo.

  • Descomprimimos la distribución de drupal que nos hemos descargado, y la ponemos accesible en el DOCUMENT_ROOT de apache:
$ cd /var/www/html
$ tar zxvf drupal-6.22.tgz
$ ln -s drupal-6.22 guifi

Drupal001.png

  • Al llegar al apartado de configuración de la base de datos, necesitaremos tener creada una base de datos local de MySQL para desarrollo. Veamos una receta básica sobre cómo crearla:
[dave@inuik http]$ mysql
...
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)

Ya podemos introducir la información de conexión a la base de datos para que drupal cree las tablas necesarias.

Drupal002.png

Instalación de los módulos de drupal necesarios para arrancar el entorno

Pongo aquí una receta sobre como descargar los módulos absolutamente necesarios para arrancar nuestro site de guifi. ATENCIÓN. Fíjate que el módulo "drupal-guifi" que estoy clonando es el de mi repositorio, el que hemos creado haciendo un fork del proyecto principal. ¿Por qué? Porque así los cambios que haga los podremos subir a gitorious, para posteriormente, si consideramos conveniente, notificar a los desarrolladores principales que los integren en la rama principal de desarrollo.

$ mkdir drupal-6.22/sites/all/modules
$ cd drupal-6.22/sites/all/modules
$ git clone git://gitorious.org/guifi/drupal-budgets.git budgets
$ # Clonado de MI FORK del módulo "drupal-guifi" 
$ git clone git@gitorious.org:~tombatossals/guifi/tombatossalss-drupal-guifi.git guifi

Módulo WebForm (http://drupal.org/project/webform):

$ wget -q -O - http://ftp.drupal.org/files/projects/webform-6.x-3.14.tar.gz | tar zxv

Módulo Views (http://drupal.org/project/views):

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

Instalación de la base de datos de desarrollo de guifi

Ya tenemos una instalación limpia de drupal hecha, ahora vamos a sobreescribir la base de datos con la información de tablas de la DB de guifi.net, lo que nos proporcionará un entorno de desarrollo similar a la web en producción. Vamos a ello:

[root@inuik dev]# mysql -u root guifi_test < guifi66_devel.sql

Afinando la instalación

Una vez instalada la base de datos con toda la informacón de la web de guifi.net, tendremos acceso a la información de cualquier nodo o zona de la web principal. Para logarte como usuario, debes utilizar el nombre de usuario correspondiente y la contraseña genérica "guifi".

El usuario administrador será "webmestre" y la contraseña "guifi".

Algunos consejos para refinar la instalación:

  • Comprueba que los directorios "files", "files/nanostation" y "tmp" del directorio de instalación de drupal tienen permisos de escritura para el usuario del servidor web (o ponlos a 777):
$ mkdir drupal-6.22/{files,files/nanostation,tmp}
$ chmod 777 drupal-6.22/{files,files/nanostation,tmp}
  • La carpeta "files/nanostation" contendrá los archivos "unsolclic" de las antenas Ubiquiti que vayamos consultando o creando.
  • Accede a la sección de configuració de "Performance", y deshabilita todo el uso de caché, optimización y compresión, nos interesa que los cambios que hagamos sobre los archivos se actualicen en tiempo real. La URL de acceso a esta configuración será del estilo: http://localhost/guifi/admin/settings/performance

Instalación del tema guifi.net en drupal

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

El tema no se activará inmediatamente, ya que le faltarán los archivos de estilos que drupal cree que están cacheados en el sistema. Para conseguir que el tema se active completamente, deberemos acceder a la "administración de temas", "configuración del tema de guifinet2011" y "grabar" sin tocar ninguna opcion. El tema por fin estará activado.

Instalación de los idiomas

La base de datos de guifi.net que hemos importado tiene habilitados varios idiomas por defecto, pero las traducciones no están instaladas en el sistema. Para solucionarlo, seguimos estos pasos:

Por ejemplo: http://ftp.drupal.org/files/translations/6.x/drupal/drupal-6.22.ca.po

  • Ves a la administración de idiomas de tu instalación como webmestre, esta localizado en /admin/settings/language, y fíjate que hay un enlace para importación manual de los strings de traducción, es esta: /admin/build/translate/import
  • Le indicas el idioma del archivo que has descargado, y lo importas, a partir de ahí ya estará la interfaz traducida.

Empezando a trabajar

Listo. Ya tienes un entorno preparado para comenzar a modificar los módulos de drupal, subirlos a tu propio repositorio, y si lo consideras conveniente, notificar tus commits a los desarrolladores para que los integren en la rama principal.

Para hacer commit de nuestros cambios:

$ cd drupal-6.22/site/all/modules/drupal-guifi
$ # Hacemos modificaciones a algunos archivos, las registramos en nuestro repositorio y procedemos a subirlas a gitorious
$ git commit -a
$ git push

Posteriormente, desde la web de gitorious.org podremos utilizar un "Request merge" para notificar a los desarrolladores alguna de nuestras modificaciones y que valoren el incorporarlo al repositorio principal.

Actualizando nuestro repositorio con los cambios del repositorio padre

Si queremos mantener nuestro repositorio actualizado con los últimos cambios que se van produciendo en el repositorio padre, deberemos seguir la siguiente receta:

# Definimos como repositorio remoto llamado "upstream" el repositorio de "drupal-guifi"
$ git remote add upstream git://gitorious.org/guifi/drupal-guifi.git

# Obtenemos los últimos cambios de nuestro repositorio
$ git fetch origin -v

# Obtenemos los últimos cambios del repositorio padre
$ git fetch upstream -v

# Hacemos el merge de los cambios obtenidos
$ git merge upstream/master
Herramientas personales