Guifi.net - Wiki Català - Contribucions de l'usuari [ca]

Unsolclic

2012-09-29T12:01:59Z

Albir:

= Introducció i Definició =

L'UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL :[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2 : [http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433 : [http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...

[[File:Addnode1.png]]

* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.

[[File:Addradio1b.png]]

* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

[[File:Addradio3b.png]]

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la següent imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
Les configuracions UnSolclic existents es basen en les següents famílies de firmwares :
* Kamikaze
* AirOs
* GuifiStation
* Mikrotik
* WRT-SveaSoft

TODO : Faltaria afegir altres firmwares com els de QMP, etc...

Actualment, tot el codi implicat dels unsolclics es troba dins de la carpeta [https://gitorious.org/guifi/drupal-guifi/trees/master/firmware firmware], on tenim un fitxer per cadascuna de les families esmentades.
<pre>
├── firmware
│   ├── [https://gitorious.org/guifi/drupal-guifi/blobs/master/firmware/airos.inc.php airos.inc.php
│   ├── firmware-todo.inc.php
│   ├── guifistationos.inc.php
│   ├── kamikaze
│   │   ├── ar71xx
│   │   │   └── kamikaze_ap.inc.php
│   │   ├── atheros
│   │   │   ├── kamikaze_ad-hoc.inc.php
│   │   │   ├── kamikaze_ap.inc.php
│   │   │   └── kamikaze_client.inc.php
│   │   ├── broadcom
│   │   │   ├── kamikaze_ad-hoc.inc.php
│   │   │   ├── kamikaze_ap.inc.php
│   │   │   └── kamikaze_client.inc.php
│   │   └── ixp4xx
│   │   └── kamikaze_ap.inc.php
│   ├── kamikaze.inc.php
│   ├── mikrotik-routeros.inc.php
│   └── wrt-sveasoft-dd.inc.php
</pre>

== Procés Original Detallat ==
* Es crida la URL de generació del UnSolclic.
* Es carrega la ruta definida a guifi.module
<pre>
$items['guifi/device/%guifi_device/view/unsolclic'] = array(
'title' => 'unsolclic',
'page callback' => 'guifi_unsolclic',
'page arguments' => array(2),
'access callback' => 'user_access',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_TASK
);
</pre>
* S'executa la funció guifi_unsolclic() del fitxer guifi_unsolclic.inc.php que rep tota la informació del device del que volem l'unsolclic
<pre>
function guifi_unsolclic($dev, $format = 'html') {
</pre>
* Es comprova que el Device tingui assignat un firmware
* Es carreguen els fitxers de la familia de firmwares corresponent
* Es comprova el firmware del trasto per cridar la funció del fitxer per aquella família.
* Es mostra per pantalla el resultat de tot el procés.

== Procés Nou Detallat ==

Continua a partir del pas tres del Procés Original

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Paràmetres ==

Llistat
* [[File:Params1b.png]]

Formulari
* [[File:Params2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Així per una banda tenim les nostres dades i per l'altre un fitxer plantilla de com volem mostrar-les.

Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Utilització de Twig ===

Des de la banda del codi, per utilitzar Twig cal incloure la llibreria, carregar l'objecte i definir mínimament el seu comportament. A la [http://twig.sensiolabs.org/doc/api.html documentació oficial] hi podem trobar el següent fragment de codi :

<pre>
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
'cache' => '/path/to/compilation_cache',
));
<pre>

Per carregar una plantilla utilitzem el següent fragment:
<pre>
$template = $twig->loadTemplate('index.html');
</pre>

i finalment per establir els valors que prendran les variables a la nostra plantilla i visualitzar-la, el següent codi :
<pre>
echo $template->render(array('the' => 'variables', 'go' => 'here'));
</pre>

=== Convencions de Guifi.net disponibles a les plantilles ===

Com podem extreure de les entitats de guifi.net la informació necessària per fer una plantilla UnSolClic?

Abans de la confecció de l'UnSolclic s'inicialitzen unes variables que contenen tota la informació de les entitats necessàries per tal que la poguem referenciar a les nostres plantilles. Aquesta informació arriba estructurada de diferents formes i hi podem accedir de dos formes:

* Amb una convenció de noms

* Jeràrquicament

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

= Plantilles UnSolclic =
== Validades ==
* Mikrotik - OmniTIK Uxx-5HnD- RouterOSv5.x
== Pendents de Validar ==
* Ubiquiti - NanoStation2 - AirOsv30
* Mikrotik -Routerboard 433 - RouterOSv4.7+
* Linksys - WRT54GL - DD-guifi (MODE AP)

== Combinacions de Model - Firmware ==

A la pràctica, com que passem a tenir una plantilla UnSolClic per cada combinació de Model / Firmware, necessitem conèixer el total de combinacions que trobem a dins de la xarxa guifi.net, per saber quantes plantilles hauriem de confeccionar.

A continuació mostrem el llistat amb totes les combinacions existents a la BD real de guifi.net a data de 15/9/2012

{|
|-
! total
! name
! model
! nom

|-
| 3818
| Ubiquiti
| NanoStation2
| AirOsv30

|-
| 2237
| Ubiquiti
| NanoStation5
| AirOsv30

|-
| 2144
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| AirOsv52

|-
| 1785
| Linksys
| WRT54GL
| DD-guifi

|-
| 1428
| Ubiquiti
| NanoStation2
| Freifunk-OLSR

|-
| 1319
| Ubiquiti
| NanoStation Loco5
| AirOsv30

|-
| 1247
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv52

|-
| 1225
| Buffalo
| WHR-HP-G54, WHR-G54S
| DD-guifi

|-
| 969
| Mikrotik
| Routerboard SXT 5HnD
| RouterOSv5.x

|-
| 892
| Ubiquiti
| NanoStation Loco2
| AirOsv30

|-
| 664
| Ubiquiti
| NanoStation Loco5
| AirOsv3.6+

|-
| 441
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| AirOsv52

|-
| 410
| Linksys
| WRT54GL
| DD-WRTv23

|-
| 362
| Ubiquiti
| NanoStation5
| AirOsv3.6+

|-
| 361
| Other
| Other
| n/a

|-
| 297
| Mikrotik
| Routerboard SXT 5HnD
| RouterOSv4.7+

|-
| 292
| Mikrotik
| Routerboard 433
| RouterOSv4.0+

|-
| 291
| Mikrotik
| Routerboard 133C
| RouterOSv2.9

|-
| 266
| Ubiquiti
| NanoStation2
| AirOsv3.6+

|-
| 243
| Buffalo
| WHR-HP-G54, WHR-G54S
| DD-WRTv23

|-
| 242
| Mikrotik
| Routerboard 433
| RouterOSv5.x

|-
| 230
| Mikrotik
| Routerboard 600
| RouterOSv5.x

|-
| 186
| Linksys
| WRT54Gv1-4
| Alchemy

|-
| 181
| Mikrotik
| Routerboard 750/G
| RouterOSv5.x

|-
| 177
| Ubiquiti
| NanoStation5
| Freifunk-OLSR

|-
| 175
| Mikrotik
| Routerboard 433
| RouterOSv3.x

|-
| 172
| Mikrotik
| Routerboard 600
| RouterOSv3.x

|-
| 169
| Linksys
| WRT54Gv1-4
| DD-WRTv23

|-
| 162
| Ubiquiti
| AirMaxM2 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv52

|-
| 160
| Mikrotik
| Routerboard 433
| RouterOSv4.7+

|-
| 124
| Ubiquiti
| NanoStation Loco2
| AirOsv3.6+

|-
| 119
| Mikrotik
| Routerboard 600
| RouterOSv4.7+

|-
| 117
| Mikrotik
| Routerboard 411
| RouterOSv5.x

|-
| 114
| Mikrotik
| Routerboard 411
| RouterOSv3.x

|-
| 112
| Mikrotik
| Routerboard 411
| RouterOSv4.7+

|-
| 112
| Mikrotik
| Routerboard 532
| RouterOSv2.9

|-
| 89
| Linksys
| WRT54Gv1-4
| DD-guifi

|-
| 79
| Mikrotik
| Routerboard 750/G
| RouterOSv4.7+

|-
| 66
| Ubiquiti
| NanoStation2
| kamikaze

|-
| 66
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv5.x

|-
| 59
| Ubiquiti
| Bullet2
| AirOsv30

|-
| 53
| Mikrotik
| Routerboard 532
| RouterOSv5.x

|-
| 46
| Mikrotik
| Routerboard 800
| RouterOSv5.x

|-
| 43
| Mikrotik
| Routerboard 133
| RouterOSv2.9

|-
| 42
| Mikrotik
| Routerboard 532
| RouterOSv4.7+

|-
| 39
| Linksys
| WRT54Gv1-4
| n/a

|-
| 39
| Ubiquiti
| NanoStation Loco2
| Freifunk-OLSR

|-
| 36
| Mikrotik
| Routerboard 493/G
| RouterOSv5.x

|-
| 32
| Ubiquiti
| RouterStation
| gsffirm

|-
| 32
| Mikrotik
| Routerboard 532
| RouterOSv3.x

|-
| 31
| Mikrotik
| Routerboard 800
| RouterOSv4.7+

|-
| 30
| Ubiquiti
| NanoStation5
| AirOsv221

|-
| 30
| Pcengines
| Alix2
| kamikaze

|-
| 29
| Mikrotik
| Routerboard 133
| RouterOSv3.x

|-
| 29
| Linksys
| WRT54GL
| whiterussian

|-
| 27
| Linksys
| WRT54GSv4
| DD-guifi

|-
| 22
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv4.7+

|-
| 21
| Linksys
| WRT54GSv4
| DD-WRTv23

|-
| 21
| Ubiquiti
| LiteStation2
| AirOsv30

|-
| 21
| Ubiquiti
| NanoStation2
| DD-WRTv23

|-
| 20
| Mikrotik
| Routerboard 133C
| RouterOSv3.x

|-
| 20
| Pcengines
| Alix2
| gsffirm

|-
| 20
| Ubiquiti
| LiteStation5
| AirOsv30

|-
| 19
| Ubiquiti
| NanoStation2
| AirOsv221

|-
| 19
| Linksys
| WRT54GL
| Freifunk-OLSR

|-
| 17
| Ubiquiti
| Bullet2
| AirOsv3.6+

|-
| 17
| Mikrotik
| OmniTIK Uxx-5HnD
| RouterOSv5.x

|-
| 17
| Ubiquiti
| NanoStation5
| DD-WRTv23

|-
| 16
| Ubiquiti
| RouterStation
| kamikaze

|-
| 15
| Linksys
| WRT54GSv1-2
| DD-guifi

|-
| 15
| Ubiquiti
| NanoStation Loco2
| kamikaze

|-
| 15
| Mikrotik
| Routerboard 333
| RouterOSv3.x

|-
| 15
| Asus
| Asus WL-500xx
| DD-WRTv23

|-
| 14
| Linksys
| WRT54GL
| kamikaze

|-
| 13
| Ubiquiti
| Bullet5
| AirOsv30

|-
| 13
| Ubiquiti
| NanoStation Loco5
| AirOsv221

|-
| 11
| Meraki
| Meraki/Fonera
| kamikaze

|-
| 11
| Mikrotik
| Routerboard 153
| RouterOSv2.9

|-
| 11
| Ubiquiti
| LiteStation2
| Freifunk-OLSR

|-
| 10
| Linksys
| WRT54Gv1-4
| kamikaze

|-
| 10
| Linksys
| WRT54GL
| DD-WRTv24preSP2

|-
| 9
| Mikrotik
| Routerboard 133
| RouterOSv4.7+

|-
| 8
| Mikrotik
| Routerboard 133C
| RouterOSv5.x

|-
| 8
| Pcengines
| Alix3
| kamikaze

|-
| 7
| Other
| Other
| DD-guifi

|-
| 7
| Mikrotik
| Routerboard 133
| RouterOSv5.x

|-
| 7
| D-Link
| DIR-600 B1/B2
| DD-WRTv24preSP2

|-
| 7
| Ubiquiti
| NanoStation Loco5
| AirOsv52

|-
| 7
| Ubiquiti
| Bullet5
| AirOsv3.6+

|-
| 7
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| AirOsv3.6+

|-
| 7
| Mikrotik
| Routerboard 112
| RouterOSv2.9

|-
| 7
| Mikrotik
| Routerboard 1100
| RouterOSv5.x

|-
| 6
| Setup Informatica
| GuifiStation2
| GuifiStationOS1.0

|-
| 6
| Linksys
| WRT54GL
| Talisman

|-
| 6
| Meraki
| Meraki/Fonera
| DD-WRTv24preSP2

|-
| 6
| Setup Informatica
| GuifiStation5
| GuifiStationOS1.0

|-
| 5
| Ubiquiti
| RouterStationPro
| kamikaze

|-
| 5
| Ubiquiti
| NanoStation Loco5
| kamikaze

|-
| 5
| Mikrotik
| Routerboard 800
| RouterOSv4.0+

|-
| 5
| Ubiquiti
| NanoStation Loco5
| DD-WRTv23

|-
| 5
| Ubiquiti
| NanoStation5
| kamikaze

|-
| 5
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv2.9

|-
| 4
| Linksys
| WRT54GL
| n/a

|-
| 4
| Mikrotik
| Routerboard 2011
| RouterOSv5.x

|-
| 4
| Ubiquiti
| RouterStation
| DD-WRTv23

|-
| 4
| Ubiquiti
| RouterStationPro
| gsffirm

|-
| 4
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv3.x

|-
| 4
| Linksys
| WRT54Gv1-4
| DD-WRTv24preSP2

|-
| 4
| Mikrotik
| Routerboard 133C
| RouterOSv4.7+

|-
| 4
| Other
| Other
| AirOsv30

|-
| 4
| Ubiquiti
| NanoStation2
| AirOsv52

|-
| 4
| Mikrotik
| Routerboard 532
| kamikaze

|-
| 4
| Ubiquiti
| NanoStation Loco5
| Freifunk-OLSR

|-
| 4
| Mikrotik
| Routerboard 493/G
| RouterOSv4.7+

|-
| 3
| Ubiquiti
| NanoStation5
| gsffirm

|-
| 3
| Ubiquiti
| NanoStation5
| AirOsv52

|-
| 3
| Ubiquiti
| NanoStation Loco2
| AirOsv221

|-
| 3
| Mikrotik
| Routerboard 333
| RouterOSv4.7+

|-
| 3
| Mikrotik
| Routerboard 600
| RouterOSv2.9

|-
| 3
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| AirOsv30

|-
| 3
| Mikrotik
| Routerboard 333
| RouterOSv5.x

|-
| 3
| Other
| Other
| Alchemy

|-
| 3
| Linksys
| WRT54GSv4
| kamikaze

|-
| 3
| Asus
| Asus WL-500xx
| kamikaze

|-
| 2
| Gateworks
| Avila GW2348-4
| kamikaze

|-
| 2
| Ubiquiti
| NanoStation Loco5
| gsffirm

|-
| 2
| Linksys
| WRT54Gv1-4
| Talisman

|-
| 2
| Asus
| Asus WL-500xx
| AirOsv52

|-
| 2
| Mikrotik
| Routerboard 750/G
| DD-guifi

|-
| 2
| Mikrotik
| Routerboard 532
| RouterOSv4.0+

|-
| 2
| Buffalo
| WHR-HP-G54, WHR-G54S
| n/a

|-
| 2
| Linksys
| WRT54GSv1-2
| kamikaze

|-
| 2
| Mikrotik
| Routerboard 1100
| RouterOSv4.7+

|-
| 2
| Ubiquiti
| RouterStationPro
| DD-WRTv23

|-
| 2
| Asus
| Asus WL-500xx
| DD-WRTv24preSP2

|-
| 2
| Linksys
| WRT54GSv1-2
| DD-WRTv23

|-
| 2
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv4.0+

|-
| 2
| Mikrotik
| Routerboard 153
| RouterOSv5.x

|-
| 2
| Other
| Other
| DD-WRTv23

|-
| 2
| Ubiquiti
| Bullet2
| Freifunk-OLSR

|-
| 2
| Linksys
| WRT54Gv1-4
| Freifunk-OLSR

|-
| 2
| Linksys
| WRT54Gv1-4
| whiterussian

|-
| 2
| Mikrotik
| Supertrasto guifiBUS guifi.net
| kamikaze

|-
| 2
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv3.6+

|-
| 1
| Other
| Other
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| AirOsv221

|-
| 1
| Asus
| Asus WL-500xx
| AirOsv221

|-
| 1
| Pcengines
| Alix1
| kamikaze

|-
| 1
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| RouterOSv5.x

|-
| 1
| Mikrotik
| Routerboard 153
| RouterOSv3.x

|-
| 1
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv30

|-
| 1
| Mikrotik
| Routerboard 133C
| n/a

|-
| 1
| Ubiquiti
| NanoStation5
| RouterOSv4.0+

|-
| 1
| Ubiquiti
| LiteStation5
| Freifunk-OLSR

|-
| 1
| Mikrotik
| Routerboard 112
| RouterOSv4.7+

|-
| 1
| Ubiquiti
| NanoStation2
| RouterOSv5.x

|-
| 1
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| Freifunk-OLSR

|-
| 1
| Ubiquiti
| Bullet2
| AirOsv221

|-
| 1
| Ubiquiti
| LiteStation5
| DD-WRTv23

|-
| 1
| Tp-Link
| TL-WA7510N
| n/a

|-
| 1
| Mikrotik
| Routerboard 600
| RouterOSv4.0+

|-
| 1
| Meraki
| Meraki/Fonera
| gsffirm

|-
| 1
| Linksys
| WRT54GSv4
| DD-WRTv24preSP2

|-
| 1
| Linksys
| WRT54GL
| RouterOSv5.x

|-
| 1
| Mikrotik
| Routerboard 750/G
| AirOsv30

|-
| 1
| Linksys
| WRT54Gv1-4
| Freifunk-BATMAN

|-
| 1
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| Bullet2
| DD-WRTv23

|-
| 1
| Linksys
| WRT54GSv1-2
| DD-WRTv24preSP2

|-
| 1
| Mikrotik
| Routerboard 153
| RouterOSv4.7+

|-
| 1
| Linksys
| WRT54GSv1-2
| Alchemy

|-
| 1
| Asus
| Asus WL-500xx
| AirOsv3.6+

|-
| 1
| Mikrotik
| Routerboard 112
| RouterOSv5.x

|-
| 1
| Ubiquiti
| AirMaxM2 Bullet/PwBrg/AirGrd/NanoBr
| DD-WRTv23

|-
| 1
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| RouterOSv2.9

|-
| 1
| Linksys
| WRT54GSv1-2
| gsffirm

|-
| 1
| Mikrotik
| Routerboard 153
| n/a

|-
| 1
| Pcengines
| Alix3
| gsffirm

|-
| 1
| Linksys
| WRT54GL
| gsffirm

|-
| 1
| Buffalo
| WHR-HP-G54, WHR-G54S
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| Bullet2
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| RouterOSv5.x

|-
| 1
| Ubiquiti
| Bullet5
| DD-WRTv23

|-
| 1
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| DD-WRTv24preSP2

|-
| 1
| Pcengines
| Alix2
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| NanoStation Loco2
| DD-WRTv23

|-
| 1
| Mikrotik
| Routerboard 133C
| AirOsv52

|-
| 1
| Ubiquiti
| NanoStation2
| gsffirm

|-
| 1
| Linksys
| WRT54GSv4
| Talisman

|-
| 1
| Linksys
| WRT54Gv1-4
| gsffirm

|-
| 1
| Ubiquiti
| NanoStation2
| DD-WRTv24preSP2

|}

== Total d'aparells per fabricant ==

Finalment com a curiositat un llistat del total de aparells agrupats per fabricant a data de 15/9/2012:

{|
|-
! total
! name

|-
| 15788
| Ubiquiti

|-
| 4223
| Mikrotik

|-
| 2859
| Linksys

|-
| 1471
| Buffalo

|-
| 378
| Other

|-
| 61
| Pcengines

|-
| 24
| Asus

|-
| 18
| Meraki

|-
| 12
| Setup Informatica

|-
| 7
| D-Link

|-
| 2
| Gateworks

|-
| 1
| Tp-Link

|}

Unsolclic

2012-09-29T11:59:53Z

Albir:

Unsolclic

2012-09-29T11:58:53Z

Albir:

= Introducció i Definició =

L'UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL :[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2 : [http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433 : [http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...

[[File:Addnode1.png]]

* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.

[[File:Addradio1b.png]]

* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

[[File:Addradio3b.png]]

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la següent imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
Les configuracions UnSolclic existents es basen en les següents famílies de firmwares :
* Kamikaze
* AirOs
* GuifiStation
* Mikrotik
* WRT-SveaSoft

TODO : Faltaria afegir altres firmwares com els de QMP, etc...

Actualment, tot el codi implicat dels unsolclics es troba dins de la carpeta [https://gitorious.org/guifi/drupal-guifi/trees/master/firmware firmware], on tenim un fitxer per cadascuna de les families esmentades.
<pre>
├── firmware
│   ├── [https://gitorious.org/guifi/drupal-guifi/blobs/master/firmware/airos.inc.php airos.inc.php
│   ├── firmware-todo.inc.php
│   ├── guifistationos.inc.php
│   ├── kamikaze
│   │   ├── ar71xx
│   │   │   └── kamikaze_ap.inc.php
│   │   ├── atheros
│   │   │   ├── kamikaze_ad-hoc.inc.php
│   │   │   ├── kamikaze_ap.inc.php
│   │   │   └── kamikaze_client.inc.php
│   │   ├── broadcom
│   │   │   ├── kamikaze_ad-hoc.inc.php
│   │   │   ├── kamikaze_ap.inc.php
│   │   │   └── kamikaze_client.inc.php
│   │   └── ixp4xx
│   │   └── kamikaze_ap.inc.php
│   ├── kamikaze.inc.php
│   ├── mikrotik-routeros.inc.php
│   └── wrt-sveasoft-dd.inc.php
</pre>

== Procés Original Detallat ==
* Es crida la URL de generació del UnSolclic.
* Es carrega la ruta definida a guifi.module
<pre>
$items['guifi/device/%guifi_device/view/unsolclic'] = array(
'title' => 'unsolclic',
'page callback' => 'guifi_unsolclic',
'page arguments' => array(2),
'access callback' => 'user_access',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_TASK
);
</pre>
* S'executa la funció guifi_unsolclic() del fitxer guifi_unsolclic.inc.php que rep tota la informació del device del que volem l'unsolclic
<pre>
function guifi_unsolclic($dev, $format = 'html') {
</pre>
* Es comprova que el Device tingui assignat un firmware
* Es carreguen els fitxers de la familia de firmwares corresponent
* Es comprova el firmware del trasto per cridar la funció del fitxer per aquella família.
* Es mostra per pantalla el resultat de tot el procés.

== Procés Nou Detallat ==

Continua a partir del pas tres del Procés Original

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Paràmetres ==

Llistat
* [[File:Params1b.png]]

Formulari
* [[File:Params2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Així per una banda tenim les nostres dades i per l'altre un fitxer plantilla de com volem mostrar-les.

Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Utilització de Twig ===

Des de la banda del codi, per utilitzar Twig cal incloure la llibreria, carregar l'objecte i definir mínimament el seu comportament. A la [http://twig.sensiolabs.org/doc/api.html documentació oficial] hi podem trobar el següent fragment de codi :

<pre>
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
'cache' => '/path/to/compilation_cache',
));
<pre>

Per carregar una plantilla utilitzem el següent fragment:
<pre>
$template = $twig->loadTemplate('index.html');
</pre>

i finalment per establir els valors que prendran les variables a la nostra plantilla i visualitzar-la, el següent codi :
<pre>
echo $template->render(array('the' => 'variables', 'go' => 'here'));
</pre>

=== Convencions de Guifi.net disponibles a les plantilles ===

Com podem extreure de les entitats de guifi.net la informació necessària per fer una plantilla UnSolClic?

Abans de la confecció de l'UnSolclic s'inicialitzen unes variables que contenen tota la informació de les entitats necessàries per tal que la poguem referenciar a les nostres plantilles. Aquesta informació arriba estructurada de diferents formes i hi podem accedir de dos formes:

* Amb una convenció de noms

* Jeràrquicament

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

= Plantilles UnSolclic =
== Validades ==
* Mikrotik - OmniTIK Uxx-5HnD- RouterOSv5.x
== Pendents de Validar ==
* Ubiquiti - NanoStation2 - AirOsv30
* Mikrotik -Routerboard 433 - RouterOSv4.7+
* Linksys - WRT54GL - DD-guifi (MODE AP)

== Combinacions de Model - Firmware ==

A la pràctica, com que passem a tenir una plantilla UnSolClic per cada combinació de Model / Firmware, necessitem conèixer el total de combinacions que trobem a dins de la xarxa guifi.net, per saber quantes plantilles hauriem de confeccionar.

A continuació mostrem el llistat amb totes les combinacions existents a la BD real de guifi.net a data de 15/9/2012

{|
|-
! total
! name
! model
! nom

|-
| 3818
| Ubiquiti
| NanoStation2
| AirOsv30

|-
| 2237
| Ubiquiti
| NanoStation5
| AirOsv30

|-
| 2144
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| AirOsv52

|-
| 1785
| Linksys
| WRT54GL
| DD-guifi

|-
| 1428
| Ubiquiti
| NanoStation2
| Freifunk-OLSR

|-
| 1319
| Ubiquiti
| NanoStation Loco5
| AirOsv30

|-
| 1247
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv52

|-
| 1225
| Buffalo
| WHR-HP-G54, WHR-G54S
| DD-guifi

|-
| 969
| Mikrotik
| Routerboard SXT 5HnD
| RouterOSv5.x

|-
| 892
| Ubiquiti
| NanoStation Loco2
| AirOsv30

|-
| 664
| Ubiquiti
| NanoStation Loco5
| AirOsv3.6+

|-
| 441
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| AirOsv52

|-
| 410
| Linksys
| WRT54GL
| DD-WRTv23

|-
| 362
| Ubiquiti
| NanoStation5
| AirOsv3.6+

|-
| 361
| Other
| Other
| n/a

|-
| 297
| Mikrotik
| Routerboard SXT 5HnD
| RouterOSv4.7+

|-
| 292
| Mikrotik
| Routerboard 433
| RouterOSv4.0+

|-
| 291
| Mikrotik
| Routerboard 133C
| RouterOSv2.9

|-
| 266
| Ubiquiti
| NanoStation2
| AirOsv3.6+

|-
| 243
| Buffalo
| WHR-HP-G54, WHR-G54S
| DD-WRTv23

|-
| 242
| Mikrotik
| Routerboard 433
| RouterOSv5.x

|-
| 230
| Mikrotik
| Routerboard 600
| RouterOSv5.x

|-
| 186
| Linksys
| WRT54Gv1-4
| Alchemy

|-
| 181
| Mikrotik
| Routerboard 750/G
| RouterOSv5.x

|-
| 177
| Ubiquiti
| NanoStation5
| Freifunk-OLSR

|-
| 175
| Mikrotik
| Routerboard 433
| RouterOSv3.x

|-
| 172
| Mikrotik
| Routerboard 600
| RouterOSv3.x

|-
| 169
| Linksys
| WRT54Gv1-4
| DD-WRTv23

|-
| 162
| Ubiquiti
| AirMaxM2 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv52

|-
| 160
| Mikrotik
| Routerboard 433
| RouterOSv4.7+

|-
| 124
| Ubiquiti
| NanoStation Loco2
| AirOsv3.6+

|-
| 119
| Mikrotik
| Routerboard 600
| RouterOSv4.7+

|-
| 117
| Mikrotik
| Routerboard 411
| RouterOSv5.x

|-
| 114
| Mikrotik
| Routerboard 411
| RouterOSv3.x

|-
| 112
| Mikrotik
| Routerboard 411
| RouterOSv4.7+

|-
| 112
| Mikrotik
| Routerboard 532
| RouterOSv2.9

|-
| 89
| Linksys
| WRT54Gv1-4
| DD-guifi

|-
| 79
| Mikrotik
| Routerboard 750/G
| RouterOSv4.7+

|-
| 66
| Ubiquiti
| NanoStation2
| kamikaze

|-
| 66
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv5.x

|-
| 59
| Ubiquiti
| Bullet2
| AirOsv30

|-
| 53
| Mikrotik
| Routerboard 532
| RouterOSv5.x

|-
| 46
| Mikrotik
| Routerboard 800
| RouterOSv5.x

|-
| 43
| Mikrotik
| Routerboard 133
| RouterOSv2.9

|-
| 42
| Mikrotik
| Routerboard 532
| RouterOSv4.7+

|-
| 39
| Linksys
| WRT54Gv1-4
| n/a

|-
| 39
| Ubiquiti
| NanoStation Loco2
| Freifunk-OLSR

|-
| 36
| Mikrotik
| Routerboard 493/G
| RouterOSv5.x

|-
| 32
| Ubiquiti
| RouterStation
| gsffirm

|-
| 32
| Mikrotik
| Routerboard 532
| RouterOSv3.x

|-
| 31
| Mikrotik
| Routerboard 800
| RouterOSv4.7+

|-
| 30
| Ubiquiti
| NanoStation5
| AirOsv221

|-
| 30
| Pcengines
| Alix2
| kamikaze

|-
| 29
| Mikrotik
| Routerboard 133
| RouterOSv3.x

|-
| 29
| Linksys
| WRT54GL
| whiterussian

|-
| 27
| Linksys
| WRT54GSv4
| DD-guifi

|-
| 22
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv4.7+

|-
| 21
| Linksys
| WRT54GSv4
| DD-WRTv23

|-
| 21
| Ubiquiti
| LiteStation2
| AirOsv30

|-
| 21
| Ubiquiti
| NanoStation2
| DD-WRTv23

|-
| 20
| Mikrotik
| Routerboard 133C
| RouterOSv3.x

|-
| 20
| Pcengines
| Alix2
| gsffirm

|-
| 20
| Ubiquiti
| LiteStation5
| AirOsv30

|-
| 19
| Ubiquiti
| NanoStation2
| AirOsv221

|-
| 19
| Linksys
| WRT54GL
| Freifunk-OLSR

|-
| 17
| Ubiquiti
| Bullet2
| AirOsv3.6+

|-
| 17
| Mikrotik
| OmniTIK Uxx-5HnD
| RouterOSv5.x

|-
| 17
| Ubiquiti
| NanoStation5
| DD-WRTv23

|-
| 16
| Ubiquiti
| RouterStation
| kamikaze

|-
| 15
| Linksys
| WRT54GSv1-2
| DD-guifi

|-
| 15
| Ubiquiti
| NanoStation Loco2
| kamikaze

|-
| 15
| Mikrotik
| Routerboard 333
| RouterOSv3.x

|-
| 15
| Asus
| Asus WL-500xx
| DD-WRTv23

|-
| 14
| Linksys
| WRT54GL
| kamikaze

|-
| 13
| Ubiquiti
| Bullet5
| AirOsv30

|-
| 13
| Ubiquiti
| NanoStation Loco5
| AirOsv221

|-
| 11
| Meraki
| Meraki/Fonera
| kamikaze

|-
| 11
| Mikrotik
| Routerboard 153
| RouterOSv2.9

|-
| 11
| Ubiquiti
| LiteStation2
| Freifunk-OLSR

|-
| 10
| Linksys
| WRT54Gv1-4
| kamikaze

|-
| 10
| Linksys
| WRT54GL
| DD-WRTv24preSP2

|-
| 9
| Mikrotik
| Routerboard 133
| RouterOSv4.7+

|-
| 8
| Mikrotik
| Routerboard 133C
| RouterOSv5.x

|-
| 8
| Pcengines
| Alix3
| kamikaze

|-
| 7
| Other
| Other
| DD-guifi

|-
| 7
| Mikrotik
| Routerboard 133
| RouterOSv5.x

|-
| 7
| D-Link
| DIR-600 B1/B2
| DD-WRTv24preSP2

|-
| 7
| Ubiquiti
| NanoStation Loco5
| AirOsv52

|-
| 7
| Ubiquiti
| Bullet5
| AirOsv3.6+

|-
| 7
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| AirOsv3.6+

|-
| 7
| Mikrotik
| Routerboard 112
| RouterOSv2.9

|-
| 7
| Mikrotik
| Routerboard 1100
| RouterOSv5.x

|-
| 6
| Setup Informatica
| GuifiStation2
| GuifiStationOS1.0

|-
| 6
| Linksys
| WRT54GL
| Talisman

|-
| 6
| Meraki
| Meraki/Fonera
| DD-WRTv24preSP2

|-
| 6
| Setup Informatica
| GuifiStation5
| GuifiStationOS1.0

|-
| 5
| Ubiquiti
| RouterStationPro
| kamikaze

|-
| 5
| Ubiquiti
| NanoStation Loco5
| kamikaze

|-
| 5
| Mikrotik
| Routerboard 800
| RouterOSv4.0+

|-
| 5
| Ubiquiti
| NanoStation Loco5
| DD-WRTv23

|-
| 5
| Ubiquiti
| NanoStation5
| kamikaze

|-
| 5
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv2.9

|-
| 4
| Linksys
| WRT54GL
| n/a

|-
| 4
| Mikrotik
| Routerboard 2011
| RouterOSv5.x

|-
| 4
| Ubiquiti
| RouterStation
| DD-WRTv23

|-
| 4
| Ubiquiti
| RouterStationPro
| gsffirm

|-
| 4
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv3.x

|-
| 4
| Linksys
| WRT54Gv1-4
| DD-WRTv24preSP2

|-
| 4
| Mikrotik
| Routerboard 133C
| RouterOSv4.7+

|-
| 4
| Other
| Other
| AirOsv30

|-
| 4
| Ubiquiti
| NanoStation2
| AirOsv52

|-
| 4
| Mikrotik
| Routerboard 532
| kamikaze

|-
| 4
| Ubiquiti
| NanoStation Loco5
| Freifunk-OLSR

|-
| 4
| Mikrotik
| Routerboard 493/G
| RouterOSv4.7+

|-
| 3
| Ubiquiti
| NanoStation5
| gsffirm

|-
| 3
| Ubiquiti
| NanoStation5
| AirOsv52

|-
| 3
| Ubiquiti
| NanoStation Loco2
| AirOsv221

|-
| 3
| Mikrotik
| Routerboard 333
| RouterOSv4.7+

|-
| 3
| Mikrotik
| Routerboard 600
| RouterOSv2.9

|-
| 3
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| AirOsv30

|-
| 3
| Mikrotik
| Routerboard 333
| RouterOSv5.x

|-
| 3
| Other
| Other
| Alchemy

|-
| 3
| Linksys
| WRT54GSv4
| kamikaze

|-
| 3
| Asus
| Asus WL-500xx
| kamikaze

|-
| 2
| Gateworks
| Avila GW2348-4
| kamikaze

|-
| 2
| Ubiquiti
| NanoStation Loco5
| gsffirm

|-
| 2
| Linksys
| WRT54Gv1-4
| Talisman

|-
| 2
| Asus
| Asus WL-500xx
| AirOsv52

|-
| 2
| Mikrotik
| Routerboard 750/G
| DD-guifi

|-
| 2
| Mikrotik
| Routerboard 532
| RouterOSv4.0+

|-
| 2
| Buffalo
| WHR-HP-G54, WHR-G54S
| n/a

|-
| 2
| Linksys
| WRT54GSv1-2
| kamikaze

|-
| 2
| Mikrotik
| Routerboard 1100
| RouterOSv4.7+

|-
| 2
| Ubiquiti
| RouterStationPro
| DD-WRTv23

|-
| 2
| Asus
| Asus WL-500xx
| DD-WRTv24preSP2

|-
| 2
| Linksys
| WRT54GSv1-2
| DD-WRTv23

|-
| 2
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv4.0+

|-
| 2
| Mikrotik
| Routerboard 153
| RouterOSv5.x

|-
| 2
| Other
| Other
| DD-WRTv23

|-
| 2
| Ubiquiti
| Bullet2
| Freifunk-OLSR

|-
| 2
| Linksys
| WRT54Gv1-4
| Freifunk-OLSR

|-
| 2
| Linksys
| WRT54Gv1-4
| whiterussian

|-
| 2
| Mikrotik
| Supertrasto guifiBUS guifi.net
| kamikaze

|-
| 2
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv3.6+

|-
| 1
| Other
| Other
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| AirOsv221

|-
| 1
| Asus
| Asus WL-500xx
| AirOsv221

|-
| 1
| Pcengines
| Alix1
| kamikaze

|-
| 1
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| RouterOSv5.x

|-
| 1
| Mikrotik
| Routerboard 153
| RouterOSv3.x

|-
| 1
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv30

|-
| 1
| Mikrotik
| Routerboard 133C
| n/a

|-
| 1
| Ubiquiti
| NanoStation5
| RouterOSv4.0+

|-
| 1
| Ubiquiti
| LiteStation5
| Freifunk-OLSR

|-
| 1
| Mikrotik
| Routerboard 112
| RouterOSv4.7+

|-
| 1
| Ubiquiti
| NanoStation2
| RouterOSv5.x

|-
| 1
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| Freifunk-OLSR

|-
| 1
| Ubiquiti
| Bullet2
| AirOsv221

|-
| 1
| Ubiquiti
| LiteStation5
| DD-WRTv23

|-
| 1
| Tp-Link
| TL-WA7510N
| n/a

|-
| 1
| Mikrotik
| Routerboard 600
| RouterOSv4.0+

|-
| 1
| Meraki
| Meraki/Fonera
| gsffirm

|-
| 1
| Linksys
| WRT54GSv4
| DD-WRTv24preSP2

|-
| 1
| Linksys
| WRT54GL
| RouterOSv5.x

|-
| 1
| Mikrotik
| Routerboard 750/G
| AirOsv30

|-
| 1
| Linksys
| WRT54Gv1-4
| Freifunk-BATMAN

|-
| 1
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| Bullet2
| DD-WRTv23

|-
| 1
| Linksys
| WRT54GSv1-2
| DD-WRTv24preSP2

|-
| 1
| Mikrotik
| Routerboard 153
| RouterOSv4.7+

|-
| 1
| Linksys
| WRT54GSv1-2
| Alchemy

|-
| 1
| Asus
| Asus WL-500xx
| AirOsv3.6+

|-
| 1
| Mikrotik
| Routerboard 112
| RouterOSv5.x

|-
| 1
| Ubiquiti
| AirMaxM2 Bullet/PwBrg/AirGrd/NanoBr
| DD-WRTv23

|-
| 1
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| RouterOSv2.9

|-
| 1
| Linksys
| WRT54GSv1-2
| gsffirm

|-
| 1
| Mikrotik
| Routerboard 153
| n/a

|-
| 1
| Pcengines
| Alix3
| gsffirm

|-
| 1
| Linksys
| WRT54GL
| gsffirm

|-
| 1
| Buffalo
| WHR-HP-G54, WHR-G54S
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| Bullet2
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| RouterOSv5.x

|-
| 1
| Ubiquiti
| Bullet5
| DD-WRTv23

|-
| 1
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| DD-WRTv24preSP2

|-
| 1
| Pcengines
| Alix2
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| NanoStation Loco2
| DD-WRTv23

|-
| 1
| Mikrotik
| Routerboard 133C
| AirOsv52

|-
| 1
| Ubiquiti
| NanoStation2
| gsffirm

|-
| 1
| Linksys
| WRT54GSv4
| Talisman

|-
| 1
| Linksys
| WRT54Gv1-4
| gsffirm

|-
| 1
| Ubiquiti
| NanoStation2
| DD-WRTv24preSP2

|}

Finalment com a curiositat un llistat del total de aparells agrupats per fabricant:

{|
|-
! total
! name

|-
| 15788
| Ubiquiti

|-
| 4223
| Mikrotik

|-
| 2859
| Linksys

|-
| 1471
| Buffalo

|-
| 378
| Other

|-
| 61
| Pcengines

|-
| 24
| Asus

|-
| 18
| Meraki

|-
| 12
| Setup Informatica

|-
| 7
| D-Link

|-
| 2
| Gateworks

|-
| 1
| Tp-Link

|}

Unsolclic

2012-09-29T11:55:55Z

Albir:

= Introducció i Definició =

L'UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL :[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2 : [http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433 : [http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...

[[File:Addnode1.png]]

* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.

[[File:Addradio1b.png]]

* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

[[File:Addradio3b.png]]

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la següent imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
Les configuracions UnSolclic existents es basen en les següents famílies de firmwares :
* Kamikaze
* AirOs
* GuifiStation
* Mikrotik
* WRT-SveaSoft

TODO : Faltaria afegir altres firmwares com els de QMP, etc...

Actualment, tot el codi implicat dels unsolclics es troba dins de la carpeta [https://gitorious.org/guifi/drupal-guifi/trees/master/firmware firmware], on tenim un fitxer per cadascuna de les families esmentades.
<pre>
├── firmware
│   ├── [https://gitorious.org/guifi/drupal-guifi/blobs/master/firmware/airos.inc.php airos.inc.php
│   ├── firmware-todo.inc.php
│   ├── guifistationos.inc.php
│   ├── kamikaze
│   │   ├── ar71xx
│   │   │   └── kamikaze_ap.inc.php
│   │   ├── atheros
│   │   │   ├── kamikaze_ad-hoc.inc.php
│   │   │   ├── kamikaze_ap.inc.php
│   │   │   └── kamikaze_client.inc.php
│   │   ├── broadcom
│   │   │   ├── kamikaze_ad-hoc.inc.php
│   │   │   ├── kamikaze_ap.inc.php
│   │   │   └── kamikaze_client.inc.php
│   │   └── ixp4xx
│   │   └── kamikaze_ap.inc.php
│   ├── kamikaze.inc.php
│   ├── mikrotik-routeros.inc.php
│   └── wrt-sveasoft-dd.inc.php
</pre>

== Procés Original Detallat ==
* Es crida la URL de generació del UnSolclic.
* Es carrega la ruta definida a guifi.module
<pre>
$items['guifi/device/%guifi_device/view/unsolclic'] = array(
'title' => 'unsolclic',
'page callback' => 'guifi_unsolclic',
'page arguments' => array(2),
'access callback' => 'user_access',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_TASK
);
</pre>
* S'executa la funció guifi_unsolclic() del fitxer guifi_unsolclic.inc.php que rep tota la informació del device del que volem l'unsolclic
<pre>
function guifi_unsolclic($dev, $format = 'html') {
</pre>
* Es comprova que el Device tingui assignat un firmware
* Es carreguen els fitxers de la familia de firmwares corresponent
* Es comprova el firmware del trasto per cridar la funció del fitxer per aquella família.
* Es mostra per pantalla el resultat de tot el procés.

== Procés Nou Detallat ==

Continua a partir del pas tres del Procés Original

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Paràmetres ==

Llistat
* [[File:Params1b.png]]

Formulari
* [[File:Params2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Així per una banda tenim les nostres dades i per l'altre un fitxer plantilla de com volem mostrar-les.

Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Utilització de Twig ===

Des de la banda del codi, per utilitzar Twig cal incloure la llibreria, carregar l'objecte i definir mínimament el seu comportament. A la [http://twig.sensiolabs.org/doc/api.html documentació oficial] hi podem trobar el següent fragment de codi :

<pre>
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
'cache' => '/path/to/compilation_cache',
));
<pre>

Per carregar una plantilla utilitzem el següent fragment:
<pre>
$template = $twig->loadTemplate('index.html');
</pre>

i finalment per establir els valors que prendran les variables a la nostra plantilla i visualitzar-la, el següent codi :
<pre>
echo $template->render(array('the' => 'variables', 'go' => 'here'));
</pre>

=== Convencions de Guifi.net disponibles a les plantilles ===

Com podem extreure de les entitats de guifi.net la informació necessària per fer una plantilla UnSolClic?

Abans de la confecció de l'UnSolclic s'inicialitzen unes variables que contenen tota la informació de les entitats necessàries per tal que la poguem referenciar a les nostres plantilles. Aquesta informació arriba estructurada de diferents formes i hi podem accedir de dos formes:

* Amb una convenció de noms

* Jeràrquicament

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

= Plantilles UnSolclic =
== Validades ==
* Mikrotik - OmniTIK Uxx-5HnD- RouterOSv5.x
== Pendents de Validar ==
* Ubiquiti - NanoStation2 - AirOsv30
* Mikrotik -Routerboard 433 - RouterOSv4.7+
* Linksys - WRT54GL - DD-guifi (MODE AP)

== Combinacions de Model - Firmware ==

A la pràctica, com que passem a tenir una plantilla UnSolClic per cada combinació de Model / Firmware, necessitem conèixer el total de combinacions que trobem a dins de la xarxa guifi.net, per saber quantes plantilles hauriem de confeccionar. A continuació mostrem el llistat amb totes les combinacions existents a la BD real de guifi.net a data de 15/9/2012

{|
|-
! total
! name
! model
! nom

|-
| 3818
| Ubiquiti
| NanoStation2
| AirOsv30

|-
| 2237
| Ubiquiti
| NanoStation5
| AirOsv30

|-
| 2144
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| AirOsv52

|-
| 1785
| Linksys
| WRT54GL
| DD-guifi

|-
| 1428
| Ubiquiti
| NanoStation2
| Freifunk-OLSR

|-
| 1319
| Ubiquiti
| NanoStation Loco5
| AirOsv30

|-
| 1247
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv52

|-
| 1225
| Buffalo
| WHR-HP-G54, WHR-G54S
| DD-guifi

|-
| 969
| Mikrotik
| Routerboard SXT 5HnD
| RouterOSv5.x

|-
| 892
| Ubiquiti
| NanoStation Loco2
| AirOsv30

|-
| 664
| Ubiquiti
| NanoStation Loco5
| AirOsv3.6+

|-
| 441
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| AirOsv52

|-
| 410
| Linksys
| WRT54GL
| DD-WRTv23

|-
| 362
| Ubiquiti
| NanoStation5
| AirOsv3.6+

|-
| 361
| Other
| Other
| n/a

|-
| 297
| Mikrotik
| Routerboard SXT 5HnD
| RouterOSv4.7+

|-
| 292
| Mikrotik
| Routerboard 433
| RouterOSv4.0+

|-
| 291
| Mikrotik
| Routerboard 133C
| RouterOSv2.9

|-
| 266
| Ubiquiti
| NanoStation2
| AirOsv3.6+

|-
| 243
| Buffalo
| WHR-HP-G54, WHR-G54S
| DD-WRTv23

|-
| 242
| Mikrotik
| Routerboard 433
| RouterOSv5.x

|-
| 230
| Mikrotik
| Routerboard 600
| RouterOSv5.x

|-
| 186
| Linksys
| WRT54Gv1-4
| Alchemy

|-
| 181
| Mikrotik
| Routerboard 750/G
| RouterOSv5.x

|-
| 177
| Ubiquiti
| NanoStation5
| Freifunk-OLSR

|-
| 175
| Mikrotik
| Routerboard 433
| RouterOSv3.x

|-
| 172
| Mikrotik
| Routerboard 600
| RouterOSv3.x

|-
| 169
| Linksys
| WRT54Gv1-4
| DD-WRTv23

|-
| 162
| Ubiquiti
| AirMaxM2 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv52

|-
| 160
| Mikrotik
| Routerboard 433
| RouterOSv4.7+

|-
| 124
| Ubiquiti
| NanoStation Loco2
| AirOsv3.6+

|-
| 119
| Mikrotik
| Routerboard 600
| RouterOSv4.7+

|-
| 117
| Mikrotik
| Routerboard 411
| RouterOSv5.x

|-
| 114
| Mikrotik
| Routerboard 411
| RouterOSv3.x

|-
| 112
| Mikrotik
| Routerboard 411
| RouterOSv4.7+

|-
| 112
| Mikrotik
| Routerboard 532
| RouterOSv2.9

|-
| 89
| Linksys
| WRT54Gv1-4
| DD-guifi

|-
| 79
| Mikrotik
| Routerboard 750/G
| RouterOSv4.7+

|-
| 66
| Ubiquiti
| NanoStation2
| kamikaze

|-
| 66
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv5.x

|-
| 59
| Ubiquiti
| Bullet2
| AirOsv30

|-
| 53
| Mikrotik
| Routerboard 532
| RouterOSv5.x

|-
| 46
| Mikrotik
| Routerboard 800
| RouterOSv5.x

|-
| 43
| Mikrotik
| Routerboard 133
| RouterOSv2.9

|-
| 42
| Mikrotik
| Routerboard 532
| RouterOSv4.7+

|-
| 39
| Linksys
| WRT54Gv1-4
| n/a

|-
| 39
| Ubiquiti
| NanoStation Loco2
| Freifunk-OLSR

|-
| 36
| Mikrotik
| Routerboard 493/G
| RouterOSv5.x

|-
| 32
| Ubiquiti
| RouterStation
| gsffirm

|-
| 32
| Mikrotik
| Routerboard 532
| RouterOSv3.x

|-
| 31
| Mikrotik
| Routerboard 800
| RouterOSv4.7+

|-
| 30
| Ubiquiti
| NanoStation5
| AirOsv221

|-
| 30
| Pcengines
| Alix2
| kamikaze

|-
| 29
| Mikrotik
| Routerboard 133
| RouterOSv3.x

|-
| 29
| Linksys
| WRT54GL
| whiterussian

|-
| 27
| Linksys
| WRT54GSv4
| DD-guifi

|-
| 22
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv4.7+

|-
| 21
| Linksys
| WRT54GSv4
| DD-WRTv23

|-
| 21
| Ubiquiti
| LiteStation2
| AirOsv30

|-
| 21
| Ubiquiti
| NanoStation2
| DD-WRTv23

|-
| 20
| Mikrotik
| Routerboard 133C
| RouterOSv3.x

|-
| 20
| Pcengines
| Alix2
| gsffirm

|-
| 20
| Ubiquiti
| LiteStation5
| AirOsv30

|-
| 19
| Ubiquiti
| NanoStation2
| AirOsv221

|-
| 19
| Linksys
| WRT54GL
| Freifunk-OLSR

|-
| 17
| Ubiquiti
| Bullet2
| AirOsv3.6+

|-
| 17
| Mikrotik
| OmniTIK Uxx-5HnD
| RouterOSv5.x

|-
| 17
| Ubiquiti
| NanoStation5
| DD-WRTv23

|-
| 16
| Ubiquiti
| RouterStation
| kamikaze

|-
| 15
| Linksys
| WRT54GSv1-2
| DD-guifi

|-
| 15
| Ubiquiti
| NanoStation Loco2
| kamikaze

|-
| 15
| Mikrotik
| Routerboard 333
| RouterOSv3.x

|-
| 15
| Asus
| Asus WL-500xx
| DD-WRTv23

|-
| 14
| Linksys
| WRT54GL
| kamikaze

|-
| 13
| Ubiquiti
| Bullet5
| AirOsv30

|-
| 13
| Ubiquiti
| NanoStation Loco5
| AirOsv221

|-
| 11
| Meraki
| Meraki/Fonera
| kamikaze

|-
| 11
| Mikrotik
| Routerboard 153
| RouterOSv2.9

|-
| 11
| Ubiquiti
| LiteStation2
| Freifunk-OLSR

|-
| 10
| Linksys
| WRT54Gv1-4
| kamikaze

|-
| 10
| Linksys
| WRT54GL
| DD-WRTv24preSP2

|-
| 9
| Mikrotik
| Routerboard 133
| RouterOSv4.7+

|-
| 8
| Mikrotik
| Routerboard 133C
| RouterOSv5.x

|-
| 8
| Pcengines
| Alix3
| kamikaze

|-
| 7
| Other
| Other
| DD-guifi

|-
| 7
| Mikrotik
| Routerboard 133
| RouterOSv5.x

|-
| 7
| D-Link
| DIR-600 B1/B2
| DD-WRTv24preSP2

|-
| 7
| Ubiquiti
| NanoStation Loco5
| AirOsv52

|-
| 7
| Ubiquiti
| Bullet5
| AirOsv3.6+

|-
| 7
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| AirOsv3.6+

|-
| 7
| Mikrotik
| Routerboard 112
| RouterOSv2.9

|-
| 7
| Mikrotik
| Routerboard 1100
| RouterOSv5.x

|-
| 6
| Setup Informatica
| GuifiStation2
| GuifiStationOS1.0

|-
| 6
| Linksys
| WRT54GL
| Talisman

|-
| 6
| Meraki
| Meraki/Fonera
| DD-WRTv24preSP2

|-
| 6
| Setup Informatica
| GuifiStation5
| GuifiStationOS1.0

|-
| 5
| Ubiquiti
| RouterStationPro
| kamikaze

|-
| 5
| Ubiquiti
| NanoStation Loco5
| kamikaze

|-
| 5
| Mikrotik
| Routerboard 800
| RouterOSv4.0+

|-
| 5
| Ubiquiti
| NanoStation Loco5
| DD-WRTv23

|-
| 5
| Ubiquiti
| NanoStation5
| kamikaze

|-
| 5
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv2.9

|-
| 4
| Linksys
| WRT54GL
| n/a

|-
| 4
| Mikrotik
| Routerboard 2011
| RouterOSv5.x

|-
| 4
| Ubiquiti
| RouterStation
| DD-WRTv23

|-
| 4
| Ubiquiti
| RouterStationPro
| gsffirm

|-
| 4
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv3.x

|-
| 4
| Linksys
| WRT54Gv1-4
| DD-WRTv24preSP2

|-
| 4
| Mikrotik
| Routerboard 133C
| RouterOSv4.7+

|-
| 4
| Other
| Other
| AirOsv30

|-
| 4
| Ubiquiti
| NanoStation2
| AirOsv52

|-
| 4
| Mikrotik
| Routerboard 532
| kamikaze

|-
| 4
| Ubiquiti
| NanoStation Loco5
| Freifunk-OLSR

|-
| 4
| Mikrotik
| Routerboard 493/G
| RouterOSv4.7+

|-
| 3
| Ubiquiti
| NanoStation5
| gsffirm

|-
| 3
| Ubiquiti
| NanoStation5
| AirOsv52

|-
| 3
| Ubiquiti
| NanoStation Loco2
| AirOsv221

|-
| 3
| Mikrotik
| Routerboard 333
| RouterOSv4.7+

|-
| 3
| Mikrotik
| Routerboard 600
| RouterOSv2.9

|-
| 3
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| AirOsv30

|-
| 3
| Mikrotik
| Routerboard 333
| RouterOSv5.x

|-
| 3
| Other
| Other
| Alchemy

|-
| 3
| Linksys
| WRT54GSv4
| kamikaze

|-
| 3
| Asus
| Asus WL-500xx
| kamikaze

|-
| 2
| Gateworks
| Avila GW2348-4
| kamikaze

|-
| 2
| Ubiquiti
| NanoStation Loco5
| gsffirm

|-
| 2
| Linksys
| WRT54Gv1-4
| Talisman

|-
| 2
| Asus
| Asus WL-500xx
| AirOsv52

|-
| 2
| Mikrotik
| Routerboard 750/G
| DD-guifi

|-
| 2
| Mikrotik
| Routerboard 532
| RouterOSv4.0+

|-
| 2
| Buffalo
| WHR-HP-G54, WHR-G54S
| n/a

|-
| 2
| Linksys
| WRT54GSv1-2
| kamikaze

|-
| 2
| Mikrotik
| Routerboard 1100
| RouterOSv4.7+

|-
| 2
| Ubiquiti
| RouterStationPro
| DD-WRTv23

|-
| 2
| Asus
| Asus WL-500xx
| DD-WRTv24preSP2

|-
| 2
| Linksys
| WRT54GSv1-2
| DD-WRTv23

|-
| 2
| Mikrotik
| Supertrasto guifiBUS guifi.net
| RouterOSv4.0+

|-
| 2
| Mikrotik
| Routerboard 153
| RouterOSv5.x

|-
| 2
| Other
| Other
| DD-WRTv23

|-
| 2
| Ubiquiti
| Bullet2
| Freifunk-OLSR

|-
| 2
| Linksys
| WRT54Gv1-4
| Freifunk-OLSR

|-
| 2
| Linksys
| WRT54Gv1-4
| whiterussian

|-
| 2
| Mikrotik
| Supertrasto guifiBUS guifi.net
| kamikaze

|-
| 2
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv3.6+

|-
| 1
| Other
| Other
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| AirOsv221

|-
| 1
| Asus
| Asus WL-500xx
| AirOsv221

|-
| 1
| Pcengines
| Alix1
| kamikaze

|-
| 1
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| RouterOSv5.x

|-
| 1
| Mikrotik
| Routerboard 153
| RouterOSv3.x

|-
| 1
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| AirOsv30

|-
| 1
| Mikrotik
| Routerboard 133C
| n/a

|-
| 1
| Ubiquiti
| NanoStation5
| RouterOSv4.0+

|-
| 1
| Ubiquiti
| LiteStation5
| Freifunk-OLSR

|-
| 1
| Mikrotik
| Routerboard 112
| RouterOSv4.7+

|-
| 1
| Ubiquiti
| NanoStation2
| RouterOSv5.x

|-
| 1
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| Freifunk-OLSR

|-
| 1
| Ubiquiti
| Bullet2
| AirOsv221

|-
| 1
| Ubiquiti
| LiteStation5
| DD-WRTv23

|-
| 1
| Tp-Link
| TL-WA7510N
| n/a

|-
| 1
| Mikrotik
| Routerboard 600
| RouterOSv4.0+

|-
| 1
| Meraki
| Meraki/Fonera
| gsffirm

|-
| 1
| Linksys
| WRT54GSv4
| DD-WRTv24preSP2

|-
| 1
| Linksys
| WRT54GL
| RouterOSv5.x

|-
| 1
| Mikrotik
| Routerboard 750/G
| AirOsv30

|-
| 1
| Linksys
| WRT54Gv1-4
| Freifunk-BATMAN

|-
| 1
| Ubiquiti
| AirMaxM2 Rocket/Nano/Loco
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| Bullet2
| DD-WRTv23

|-
| 1
| Linksys
| WRT54GSv1-2
| DD-WRTv24preSP2

|-
| 1
| Mikrotik
| Routerboard 153
| RouterOSv4.7+

|-
| 1
| Linksys
| WRT54GSv1-2
| Alchemy

|-
| 1
| Asus
| Asus WL-500xx
| AirOsv3.6+

|-
| 1
| Mikrotik
| Routerboard 112
| RouterOSv5.x

|-
| 1
| Ubiquiti
| AirMaxM2 Bullet/PwBrg/AirGrd/NanoBr
| DD-WRTv23

|-
| 1
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| RouterOSv2.9

|-
| 1
| Linksys
| WRT54GSv1-2
| gsffirm

|-
| 1
| Mikrotik
| Routerboard 153
| n/a

|-
| 1
| Pcengines
| Alix3
| gsffirm

|-
| 1
| Linksys
| WRT54GL
| gsffirm

|-
| 1
| Buffalo
| WHR-HP-G54, WHR-G54S
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| Bullet2
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| RouterOSv5.x

|-
| 1
| Ubiquiti
| Bullet5
| DD-WRTv23

|-
| 1
| Ubiquiti
| AirMaxM5 Rocket/Nano/Loco
| DD-WRTv24preSP2

|-
| 1
| Pcengines
| Alix2
| DD-WRTv24preSP2

|-
| 1
| Ubiquiti
| NanoStation Loco2
| DD-WRTv23

|-
| 1
| Mikrotik
| Routerboard 133C
| AirOsv52

|-
| 1
| Ubiquiti
| NanoStation2
| gsffirm

|-
| 1
| Linksys
| WRT54GSv4
| Talisman

|-
| 1
| Linksys
| WRT54Gv1-4
| gsffirm

|-
| 1
| Ubiquiti
| NanoStation2
| DD-WRTv24preSP2

|}

Unsolclic

2012-09-29T11:54:15Z

Albir:

= Introducció i Definició =

L'UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL :[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2 : [http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433 : [http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...

[[File:Addnode1.png]]

* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.

[[File:Addradio1b.png]]

* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

[[File:Addradio3b.png]]

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la següent imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
Les configuracions UnSolclic existents es basen en les següents famílies de firmwares :
* Kamikaze
* AirOs
* GuifiStation
* Mikrotik
* WRT-SveaSoft

TODO : Faltaria afegir altres firmwares com els de QMP, etc...

Actualment, tot el codi implicat dels unsolclics es troba dins de la carpeta [https://gitorious.org/guifi/drupal-guifi/trees/master/firmware firmware], on tenim un fitxer per cadascuna de les families esmentades.
<pre>
├── firmware
│   ├── [https://gitorious.org/guifi/drupal-guifi/blobs/master/firmware/airos.inc.php airos.inc.php
│   ├── firmware-todo.inc.php
│   ├── guifistationos.inc.php
│   ├── kamikaze
│   │   ├── ar71xx
│   │   │   └── kamikaze_ap.inc.php
│   │   ├── atheros
│   │   │   ├── kamikaze_ad-hoc.inc.php
│   │   │   ├── kamikaze_ap.inc.php
│   │   │   └── kamikaze_client.inc.php
│   │   ├── broadcom
│   │   │   ├── kamikaze_ad-hoc.inc.php
│   │   │   ├── kamikaze_ap.inc.php
│   │   │   └── kamikaze_client.inc.php
│   │   └── ixp4xx
│   │   └── kamikaze_ap.inc.php
│   ├── kamikaze.inc.php
│   ├── mikrotik-routeros.inc.php
│   └── wrt-sveasoft-dd.inc.php
</pre>

== Procés Original Detallat ==
* Es crida la URL de generació del UnSolclic.
* Es carrega la ruta definida a guifi.module
<pre>
$items['guifi/device/%guifi_device/view/unsolclic'] = array(
'title' => 'unsolclic',
'page callback' => 'guifi_unsolclic',
'page arguments' => array(2),
'access callback' => 'user_access',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_TASK
);
</pre>
* S'executa la funció guifi_unsolclic() del fitxer guifi_unsolclic.inc.php que rep tota la informació del device del que volem l'unsolclic
<pre>
function guifi_unsolclic($dev, $format = 'html') {
</pre>
* Es comprova que el Device tingui assignat un firmware
* Es carreguen els fitxers de la familia de firmwares corresponent
* Es comprova el firmware del trasto per cridar la funció del fitxer per aquella família.
* Es mostra per pantalla el resultat de tot el procés.

== Procés Nou Detallat ==

Continua a partir del pas tres del Procés Original

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Paràmetres ==

Llistat
* [[File:Params1b.png]]

Formulari
* [[File:Params2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Així per una banda tenim les nostres dades i per l'altre un fitxer plantilla de com volem mostrar-les.

Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Utilització de Twig ===

Des de la banda del codi, per utilitzar Twig cal incloure la llibreria, carregar l'objecte i definir mínimament el seu comportament. A la [http://twig.sensiolabs.org/doc/api.html documentació oficial] hi podem trobar el següent fragment de codi :

<pre>
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
'cache' => '/path/to/compilation_cache',
));
<pre>

Per carregar una plantilla utilitzem el següent fragment:
<pre>
$template = $twig->loadTemplate('index.html');
</pre>

i finalment per establir els valors que prendran les variables a la nostra plantilla i visualitzar-la, el següent codi :
<pre>
echo $template->render(array('the' => 'variables', 'go' => 'here'));
</pre>

=== Convencions de Guifi.net disponibles a les plantilles ===

Com podem extreure de les entitats de guifi.net la informació necessària per fer una plantilla UnSolClic?

Abans de la confecció de l'UnSolclic s'inicialitzen unes variables que contenen tota la informació de les entitats necessàries per tal que la poguem referenciar a les nostres plantilles. Aquesta informació arriba estructurada de diferents formes i hi podem accedir de dos formes:

* Amb una convenció de noms

* Jeràrquicament

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

= Plantilles UnSolclic =
== Validades ==
* Mikrotik - OmniTIK Uxx-5HnD- RouterOSv5.x
== Pendents de Validar ==
* Ubiquiti - NanoStation2 - AirOsv30
* Mikrotik -Routerboard 433 - RouterOSv4.7+
* Linksys - WRT54GL - DD-guifi (MODE AP)

== Combinacions de Model - Firmware ==

A la pràctica, com que passem a tenir una plantilla UnSolClic per cada combinació de Model / Firmware, necessitem conèixer el total de combinacions que trobem a dins de la xarxa guifi.net, per saber quantes plantilles hauriem de confeccionar. A continuació mostrem el llistat amb totes les combinacions.

{|
|-
! total</td>
! name</td>
! model</td>
! nom</td>

|-
| 3818</td>
| Ubiquiti</td>
| NanoStation2</td>
| AirOsv30</td>

|-
| 2237</td>
| Ubiquiti</td>
| NanoStation5</td>
| AirOsv30</td>

|-
| 2144</td>
| Ubiquiti</td>
| AirMaxM5 Rocket/Nano/Loco</td>
| AirOsv52</td>

|-
| 1785</td>
| Linksys</td>
| WRT54GL</td>
| DD-guifi</td>

|-
| 1428</td>
| Ubiquiti</td>
| NanoStation2</td>
| Freifunk-OLSR</td>

|-
| 1319</td>
| Ubiquiti</td>
| NanoStation Loco5</td>
| AirOsv30</td>

|-
| 1247</td>
| Ubiquiti</td>
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr</td>
| AirOsv52</td>

|-
| 1225</td>
| Buffalo</td>
| WHR-HP-G54, WHR-G54S</td>
| DD-guifi</td>

|-
| 969</td>
| Mikrotik</td>
| Routerboard SXT 5HnD</td>
| RouterOSv5.x</td>

|-
| 892</td>
| Ubiquiti</td>
| NanoStation Loco2</td>
| AirOsv30</td>

|-
| 664</td>
| Ubiquiti</td>
| NanoStation Loco5</td>
| AirOsv3.6+</td>

|-
| 441</td>
| Ubiquiti</td>
| AirMaxM2 Rocket/Nano/Loco</td>
| AirOsv52</td>

|-
| 410</td>
| Linksys</td>
| WRT54GL</td>
| DD-WRTv23</td>

|-
| 362</td>
| Ubiquiti</td>
| NanoStation5</td>
| AirOsv3.6+</td>

|-
| 361</td>
| Other</td>
| Other</td>
| n/a</td>

|-
| 297</td>
| Mikrotik</td>
| Routerboard SXT 5HnD</td>
| RouterOSv4.7+</td>

|-
| 292</td>
| Mikrotik</td>
| Routerboard 433</td>
| RouterOSv4.0+</td>

|-
| 291</td>
| Mikrotik</td>
| Routerboard 133C</td>
| RouterOSv2.9</td>

|-
| 266</td>
| Ubiquiti</td>
| NanoStation2</td>
| AirOsv3.6+</td>

|-
| 243</td>
| Buffalo</td>
| WHR-HP-G54, WHR-G54S</td>
| DD-WRTv23</td>

|-
| 242</td>
| Mikrotik</td>
| Routerboard 433</td>
| RouterOSv5.x</td>

|-
| 230</td>
| Mikrotik</td>
| Routerboard 600</td>
| RouterOSv5.x</td>

|-
| 186</td>
| Linksys</td>
| WRT54Gv1-4</td>
| Alchemy</td>

|-
| 181</td>
| Mikrotik</td>
| Routerboard 750/G</td>
| RouterOSv5.x</td>

|-
| 177</td>
| Ubiquiti</td>
| NanoStation5</td>
| Freifunk-OLSR</td>

|-
| 175</td>
| Mikrotik</td>
| Routerboard 433</td>
| RouterOSv3.x</td>

|-
| 172</td>
| Mikrotik</td>
| Routerboard 600</td>
| RouterOSv3.x</td>

|-
| 169</td>
| Linksys</td>
| WRT54Gv1-4</td>
| DD-WRTv23</td>

|-
| 162</td>
| Ubiquiti</td>
| AirMaxM2 Bullet/PwBrg/AirGrd/NanoBr</td>
| AirOsv52</td>

|-
| 160</td>
| Mikrotik</td>
| Routerboard 433</td>
| RouterOSv4.7+</td>

|-
| 124</td>
| Ubiquiti</td>
| NanoStation Loco2</td>
| AirOsv3.6+</td>

|-
| 119</td>
| Mikrotik</td>
| Routerboard 600</td>
| RouterOSv4.7+</td>

|-
| 117</td>
| Mikrotik</td>
| Routerboard 411</td>
| RouterOSv5.x</td>

|-
| 114</td>
| Mikrotik</td>
| Routerboard 411</td>
| RouterOSv3.x</td>

|-
| 112</td>
| Mikrotik</td>
| Routerboard 411</td>
| RouterOSv4.7+</td>

|-
| 112</td>
| Mikrotik</td>
| Routerboard 532</td>
| RouterOSv2.9</td>

|-
| 89</td>
| Linksys</td>
| WRT54Gv1-4</td>
| DD-guifi</td>

|-
| 79</td>
| Mikrotik</td>
| Routerboard 750/G</td>
| RouterOSv4.7+</td>

|-
| 66</td>
| Ubiquiti</td>
| NanoStation2</td>
| kamikaze</td>

|-
| 66</td>
| Mikrotik</td>
| Supertrasto guifiBUS guifi.net</td>
| RouterOSv5.x</td>

|-
| 59</td>
| Ubiquiti</td>
| Bullet2</td>
| AirOsv30</td>

|-
| 53</td>
| Mikrotik</td>
| Routerboard 532</td>
| RouterOSv5.x</td>

|-
| 46</td>
| Mikrotik</td>
| Routerboard 800</td>
| RouterOSv5.x</td>

|-
| 43</td>
| Mikrotik</td>
| Routerboard 133</td>
| RouterOSv2.9</td>

|-
| 42</td>
| Mikrotik</td>
| Routerboard 532</td>
| RouterOSv4.7+</td>

|-
| 39</td>
| Linksys</td>
| WRT54Gv1-4</td>
| n/a</td>

|-
| 39</td>
| Ubiquiti</td>
| NanoStation Loco2</td>
| Freifunk-OLSR</td>

|-
| 36</td>
| Mikrotik</td>
| Routerboard 493/G</td>
| RouterOSv5.x</td>

|-
| 32</td>
| Ubiquiti</td>
| RouterStation</td>
| gsffirm</td>

|-
| 32</td>
| Mikrotik</td>
| Routerboard 532</td>
| RouterOSv3.x</td>

|-
| 31</td>
| Mikrotik</td>
| Routerboard 800</td>
| RouterOSv4.7+</td>

|-
| 30</td>
| Ubiquiti</td>
| NanoStation5</td>
| AirOsv221</td>

|-
| 30</td>
| Pcengines</td>
| Alix2</td>
| kamikaze</td>

|-
| 29</td>
| Mikrotik</td>
| Routerboard 133</td>
| RouterOSv3.x</td>

|-
| 29</td>
| Linksys</td>
| WRT54GL</td>
| whiterussian</td>

|-
| 27</td>
| Linksys</td>
| WRT54GSv4</td>
| DD-guifi</td>

|-
| 22</td>
| Mikrotik</td>
| Supertrasto guifiBUS guifi.net</td>
| RouterOSv4.7+</td>

|-
| 21</td>
| Linksys</td>
| WRT54GSv4</td>
| DD-WRTv23</td>

|-
| 21</td>
| Ubiquiti</td>
| LiteStation2</td>
| AirOsv30</td>

|-
| 21</td>
| Ubiquiti</td>
| NanoStation2</td>
| DD-WRTv23</td>

|-
| 20</td>
| Mikrotik</td>
| Routerboard 133C</td>
| RouterOSv3.x</td>

|-
| 20</td>
| Pcengines</td>
| Alix2</td>
| gsffirm</td>

|-
| 20</td>
| Ubiquiti</td>
| LiteStation5</td>
| AirOsv30</td>

|-
| 19</td>
| Ubiquiti</td>
| NanoStation2</td>
| AirOsv221</td>

|-
| 19</td>
| Linksys</td>
| WRT54GL</td>
| Freifunk-OLSR</td>

|-
| 17</td>
| Ubiquiti</td>
| Bullet2</td>
| AirOsv3.6+</td>

|-
| 17</td>
| Mikrotik</td>
| OmniTIK Uxx-5HnD</td>
| RouterOSv5.x</td>

|-
| 17</td>
| Ubiquiti</td>
| NanoStation5</td>
| DD-WRTv23</td>

|-
| 16</td>
| Ubiquiti</td>
| RouterStation</td>
| kamikaze</td>

|-
| 15</td>
| Linksys</td>
| WRT54GSv1-2</td>
| DD-guifi</td>

|-
| 15</td>
| Ubiquiti</td>
| NanoStation Loco2</td>
| kamikaze</td>

|-
| 15</td>
| Mikrotik</td>
| Routerboard 333</td>
| RouterOSv3.x</td>

|-
| 15</td>
| Asus</td>
| Asus WL-500xx</td>
| DD-WRTv23</td>

|-
| 14</td>
| Linksys</td>
| WRT54GL</td>
| kamikaze</td>

|-
| 13</td>
| Ubiquiti</td>
| Bullet5</td>
| AirOsv30</td>

|-
| 13</td>
| Ubiquiti</td>
| NanoStation Loco5</td>
| AirOsv221</td>

|-
| 11</td>
| Meraki</td>
| Meraki/Fonera</td>
| kamikaze</td>

|-
| 11</td>
| Mikrotik</td>
| Routerboard 153</td>
| RouterOSv2.9</td>

|-
| 11</td>
| Ubiquiti</td>
| LiteStation2</td>
| Freifunk-OLSR</td>

|-
| 10</td>
| Linksys</td>
| WRT54Gv1-4</td>
| kamikaze</td>

|-
| 10</td>
| Linksys</td>
| WRT54GL</td>
| DD-WRTv24preSP2</td>

|-
| 9</td>
| Mikrotik</td>
| Routerboard 133</td>
| RouterOSv4.7+</td>

|-
| 8</td>
| Mikrotik</td>
| Routerboard 133C</td>
| RouterOSv5.x</td>

|-
| 8</td>
| Pcengines</td>
| Alix3</td>
| kamikaze</td>

|-
| 7</td>
| Other</td>
| Other</td>
| DD-guifi</td>

|-
| 7</td>
| Mikrotik</td>
| Routerboard 133</td>
| RouterOSv5.x</td>

|-
| 7</td>
| D-Link</td>
| DIR-600 B1/B2</td>
| DD-WRTv24preSP2</td>

|-
| 7</td>
| Ubiquiti</td>
| NanoStation Loco5</td>
| AirOsv52</td>

|-
| 7</td>
| Ubiquiti</td>
| Bullet5</td>
| AirOsv3.6+</td>

|-
| 7</td>
| Ubiquiti</td>
| AirMaxM5 Rocket/Nano/Loco</td>
| AirOsv3.6+</td>

|-
| 7</td>
| Mikrotik</td>
| Routerboard 112</td>
| RouterOSv2.9</td>

|-
| 7</td>
| Mikrotik</td>
| Routerboard 1100</td>
| RouterOSv5.x</td>

|-
| 6</td>
| Setup Informatica</td>
| GuifiStation2</td>
| GuifiStationOS1.0</td>

|-
| 6</td>
| Linksys</td>
| WRT54GL</td>
| Talisman</td>

|-
| 6</td>
| Meraki</td>
| Meraki/Fonera</td>
| DD-WRTv24preSP2</td>

|-
| 6</td>
| Setup Informatica</td>
| GuifiStation5</td>
| GuifiStationOS1.0</td>

|-
| 5</td>
| Ubiquiti</td>
| RouterStationPro</td>
| kamikaze</td>

|-
| 5</td>
| Ubiquiti</td>
| NanoStation Loco5</td>
| kamikaze</td>

|-
| 5</td>
| Mikrotik</td>
| Routerboard 800</td>
| RouterOSv4.0+</td>

|-
| 5</td>
| Ubiquiti</td>
| NanoStation Loco5</td>
| DD-WRTv23</td>

|-
| 5</td>
| Ubiquiti</td>
| NanoStation5</td>
| kamikaze</td>

|-
| 5</td>
| Mikrotik</td>
| Supertrasto guifiBUS guifi.net</td>
| RouterOSv2.9</td>

|-
| 4</td>
| Linksys</td>
| WRT54GL</td>
| n/a</td>

|-
| 4</td>
| Mikrotik</td>
| Routerboard 2011</td>
| RouterOSv5.x</td>

|-
| 4</td>
| Ubiquiti</td>
| RouterStation</td>
| DD-WRTv23</td>

|-
| 4</td>
| Ubiquiti</td>
| RouterStationPro</td>
| gsffirm</td>

|-
| 4</td>
| Mikrotik</td>
| Supertrasto guifiBUS guifi.net</td>
| RouterOSv3.x</td>

|-
| 4</td>
| Linksys</td>
| WRT54Gv1-4</td>
| DD-WRTv24preSP2</td>

|-
| 4</td>
| Mikrotik</td>
| Routerboard 133C</td>
| RouterOSv4.7+</td>

|-
| 4</td>
| Other</td>
| Other</td>
| AirOsv30</td>

|-
| 4</td>
| Ubiquiti</td>
| NanoStation2</td>
| AirOsv52</td>

|-
| 4</td>
| Mikrotik</td>
| Routerboard 532</td>
| kamikaze</td>

|-
| 4</td>
| Ubiquiti</td>
| NanoStation Loco5</td>
| Freifunk-OLSR</td>

|-
| 4</td>
| Mikrotik</td>
| Routerboard 493/G</td>
| RouterOSv4.7+</td>

|-
| 3</td>
| Ubiquiti</td>
| NanoStation5</td>
| gsffirm</td>

|-
| 3</td>
| Ubiquiti</td>
| NanoStation5</td>
| AirOsv52</td>

|-
| 3</td>
| Ubiquiti</td>
| NanoStation Loco2</td>
| AirOsv221</td>

|-
| 3</td>
| Mikrotik</td>
| Routerboard 333</td>
| RouterOSv4.7+</td>

|-
| 3</td>
| Mikrotik</td>
| Routerboard 600</td>
| RouterOSv2.9</td>

|-
| 3</td>
| Ubiquiti</td>
| AirMaxM5 Rocket/Nano/Loco</td>
| AirOsv30</td>

|-
| 3</td>
| Mikrotik</td>
| Routerboard 333</td>
| RouterOSv5.x</td>

|-
| 3</td>
| Other</td>
| Other</td>
| Alchemy</td>

|-
| 3</td>
| Linksys</td>
| WRT54GSv4</td>
| kamikaze</td>

|-
| 3</td>
| Asus</td>
| Asus WL-500xx</td>
| kamikaze</td>

|-
| 2</td>
| Gateworks</td>
| Avila GW2348-4</td>
| kamikaze</td>

|-
| 2</td>
| Ubiquiti</td>
| NanoStation Loco5</td>
| gsffirm</td>

|-
| 2</td>
| Linksys</td>
| WRT54Gv1-4</td>
| Talisman</td>

|-
| 2</td>
| Asus</td>
| Asus WL-500xx</td>
| AirOsv52</td>

|-
| 2</td>
| Mikrotik</td>
| Routerboard 750/G</td>
| DD-guifi</td>

|-
| 2</td>
| Mikrotik</td>
| Routerboard 532</td>
| RouterOSv4.0+</td>

|-
| 2</td>
| Buffalo</td>
| WHR-HP-G54, WHR-G54S</td>
| n/a</td>

|-
| 2</td>
| Linksys</td>
| WRT54GSv1-2</td>
| kamikaze</td>

|-
| 2</td>
| Mikrotik</td>
| Routerboard 1100</td>
| RouterOSv4.7+</td>

|-
| 2</td>
| Ubiquiti</td>
| RouterStationPro</td>
| DD-WRTv23</td>

|-
| 2</td>
| Asus</td>
| Asus WL-500xx</td>
| DD-WRTv24preSP2</td>

|-
| 2</td>
| Linksys</td>
| WRT54GSv1-2</td>
| DD-WRTv23</td>

|-
| 2</td>
| Mikrotik</td>
| Supertrasto guifiBUS guifi.net</td>
| RouterOSv4.0+</td>

|-
| 2</td>
| Mikrotik</td>
| Routerboard 153</td>
| RouterOSv5.x</td>

|-
| 2</td>
| Other</td>
| Other</td>
| DD-WRTv23</td>

|-
| 2</td>
| Ubiquiti</td>
| Bullet2</td>
| Freifunk-OLSR</td>

|-
| 2</td>
| Linksys</td>
| WRT54Gv1-4</td>
| Freifunk-OLSR</td>

|-
| 2</td>
| Linksys</td>
| WRT54Gv1-4</td>
| whiterussian</td>

|-
| 2</td>
| Mikrotik</td>
| Supertrasto guifiBUS guifi.net</td>
| kamikaze</td>

|-
| 2</td>
| Ubiquiti</td>
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr</td>
| AirOsv3.6+</td>

|-
| 1</td>
| Other</td>
| Other</td>
| DD-WRTv24preSP2</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM2 Rocket/Nano/Loco</td>
| AirOsv221</td>

|-
| 1</td>
| Asus</td>
| Asus WL-500xx</td>
| AirOsv221</td>

|-
| 1</td>
| Pcengines</td>
| Alix1</td>
| kamikaze</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM2 Rocket/Nano/Loco</td>
| RouterOSv5.x</td>

|-
| 1</td>
| Mikrotik</td>
| Routerboard 153</td>
| RouterOSv3.x</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr</td>
| AirOsv30</td>

|-
| 1</td>
| Mikrotik</td>
| Routerboard 133C</td>
| n/a</td>

|-
| 1</td>
| Ubiquiti</td>
| NanoStation5</td>
| RouterOSv4.0+</td>

|-
| 1</td>
| Ubiquiti</td>
| LiteStation5</td>
| Freifunk-OLSR</td>

|-
| 1</td>
| Mikrotik</td>
| Routerboard 112</td>
| RouterOSv4.7+</td>

|-
| 1</td>
| Ubiquiti</td>
| NanoStation2</td>
| RouterOSv5.x</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr</td>
| Freifunk-OLSR</td>

|-
| 1</td>
| Ubiquiti</td>
| Bullet2</td>
| AirOsv221</td>

|-
| 1</td>
| Ubiquiti</td>
| LiteStation5</td>
| DD-WRTv23</td>

|-
| 1</td>
| Tp-Link</td>
| TL-WA7510N</td>
| n/a</td>

|-
| 1</td>
| Mikrotik</td>
| Routerboard 600</td>
| RouterOSv4.0+</td>

|-
| 1</td>
| Meraki</td>
| Meraki/Fonera</td>
| gsffirm</td>

|-
| 1</td>
| Linksys</td>
| WRT54GSv4</td>
| DD-WRTv24preSP2</td>

|-
| 1</td>
| Linksys</td>
| WRT54GL</td>
| RouterOSv5.x</td>

|-
| 1</td>
| Mikrotik</td>
| Routerboard 750/G</td>
| AirOsv30</td>

|-
| 1</td>
| Linksys</td>
| WRT54Gv1-4</td>
| Freifunk-BATMAN</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM2 Rocket/Nano/Loco</td>
| DD-WRTv24preSP2</td>

|-
| 1</td>
| Ubiquiti</td>
| Bullet2</td>
| DD-WRTv23</td>

|-
| 1</td>
| Linksys</td>
| WRT54GSv1-2</td>
| DD-WRTv24preSP2</td>

|-
| 1</td>
| Mikrotik</td>
| Routerboard 153</td>
| RouterOSv4.7+</td>

|-
| 1</td>
| Linksys</td>
| WRT54GSv1-2</td>
| Alchemy</td>

|-
| 1</td>
| Asus</td>
| Asus WL-500xx</td>
| AirOsv3.6+</td>

|-
| 1</td>
| Mikrotik</td>
| Routerboard 112</td>
| RouterOSv5.x</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM2 Bullet/PwBrg/AirGrd/NanoBr</td>
| DD-WRTv23</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM5 Rocket/Nano/Loco</td>
| RouterOSv2.9</td>

|-
| 1</td>
| Linksys</td>
| WRT54GSv1-2</td>
| gsffirm</td>

|-
| 1</td>
| Mikrotik</td>
| Routerboard 153</td>
| n/a</td>

|-
| 1</td>
| Pcengines</td>
| Alix3</td>
| gsffirm</td>

|-
| 1</td>
| Linksys</td>
| WRT54GL</td>
| gsffirm</td>

|-
| 1</td>
| Buffalo</td>
| WHR-HP-G54, WHR-G54S</td>
| DD-WRTv24preSP2</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM5 Bullet/PwBrg/AirGrd/NanoBr</td>
| DD-WRTv24preSP2</td>

|-
| 1</td>
| Ubiquiti</td>
| Bullet2</td>
| DD-WRTv24preSP2</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM5 Rocket/Nano/Loco</td>
| RouterOSv5.x</td>

|-
| 1</td>
| Ubiquiti</td>
| Bullet5</td>
| DD-WRTv23</td>

|-
| 1</td>
| Ubiquiti</td>
| AirMaxM5 Rocket/Nano/Loco</td>
| DD-WRTv24preSP2</td>

|-
| 1</td>
| Pcengines</td>
| Alix2</td>
| DD-WRTv24preSP2</td>

|-
| 1</td>
| Ubiquiti</td>
| NanoStation Loco2</td>
| DD-WRTv23</td>

|-
| 1</td>
| Mikrotik</td>
| Routerboard 133C</td>
| AirOsv52</td>

|-
| 1</td>
| Ubiquiti</td>
| NanoStation2</td>
| gsffirm</td>

|-
| 1</td>
| Linksys</td>
| WRT54GSv4</td>
| Talisman</td>

|-
| 1</td>
| Linksys</td>
| WRT54Gv1-4</td>
| gsffirm</td>

|-
| 1</td>
| Ubiquiti</td>
| NanoStation2</td>
| DD-WRTv24preSP2</td>

|}

Unsolclic

2012-09-28T22:38:40Z

Albir:

Unsolclic

2012-09-28T22:23:23Z

Albir:

Unsolclic

2012-09-28T22:22:18Z

Albir:

Unsolclic

2012-09-28T22:09:43Z

Albir:

= Introducció i Definició =

El UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL :[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2 : [http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433 : [http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...

[[File:Addnode1.png]]

* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.

[[File:Addradio1b.png]]

* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

[[File:Addradio3b.png]]

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la següent imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
Les configuracions UnSolclic existents es basen en les següents famílies de firmwares :
* Kamikaze
* AirOs
* GuifiStation
* Mikrotik
* WRT-SveaSoft

TODO : Faltaria afegir altres firmwares com els de QMP, etc...

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Paràmetres ==

Llistat
* [[File:Params1b.png]]

Formulari
* [[File:Params2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Així per una banda tenim les nostres dades i per l'altre un fitxer plantilla de com volem mostrar-les.

Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Utilització de Twig ===

Des de la banda del codi, per utilitzar Twig cal incloure la llibreria, carregar l'objecte i definir mínimament el seu comportament. A la [http://twig.sensiolabs.org/doc/api.html documentació oficial] hi podem trobar el següent fragment de codi :

<pre>
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
'cache' => '/path/to/compilation_cache',
));
<pre>

Per carregar una plantilla utilitzem el següent fragment:
<pre>
$template = $twig->loadTemplate('index.html');
</pre>

i finalment per establir els valors que prendran les variables a la nostra plantilla i visualitzar-la, el següent codi :
<pre>
echo $template->render(array('the' => 'variables', 'go' => 'here'));
</pre>

=== Convencions de Guifi.net disponibles a les plantilles ===

Com podem extreure de les entitats de guifi.net la informació necessària per fer una plantilla UnSolClic?

Abans de la confecció de l'UnSolclic s'inicialitzen unes variables que contenen tota la informació de les entitats necessàries per tal que la poguem referenciar a les nostres plantilles. Aquesta informació arriba estructurada de diferents formes i hi podem accedir de dos formes:

* Amb una convenció de noms

* Jeràrquicament

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

Unsolclic

2012-09-28T22:08:18Z

Albir:

Unsolclic

2012-09-28T22:06:14Z

Albir:

Unsolclic

2012-09-28T21:40:14Z

Albir:

Unsolclic

2012-09-28T21:37:04Z

Albir:

= Introducció i Definició =

El UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL :[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2 : [http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433 : [http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...

[[File:Addnode1.png]]

* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.

[[File:Addradio1b.png]]

* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

[[File:Addradio3b.png]]

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la següent imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
Les configuracions UnSolclic existents es basen en les següents famílies de firmwares :
* Kamikaze
* AirOs
* GuifiStation
* Mikrotik
* WRT-SveaSoft

TODO : Faltaria afegir altres firmwares com els de QMP, etc...

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Així per una banda tenim les nostres dades i per l'altre un fitxer plantilla de com volem mostrar-les.

Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Utilització de Twig ===

Des de la banda del codi, per utilitzar Twig cal incloure la llibreria, carregar l'objecte i definir mínimament el seu comportament. A la [http://twig.sensiolabs.org/doc/api.html documentació oficial] hi podem trobar el següent fragment de codi :

<pre>
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
'cache' => '/path/to/compilation_cache',
));
<pre>

Per carregar una plantilla utilitzem el següent fragment:
<pre>
$template = $twig->loadTemplate('index.html');
</pre>

i finalment per establir els valors que prendran les variables a la nostra plantilla i visualitzar-la, el següent codi :
<pre>
echo $template->render(array('the' => 'variables', 'go' => 'here'));
</pre>

=== Convencions de Guifi.net disponibles a les plantilles ===

Com podem extreure de les entitats de guifi.net la informació necessària per fer una plantilla UnSolClic?

Abans de la confecció de l'UnSolclic s'inicialitzen unes variables que contenen tota la informació de les entitats necessàries per tal que la poguem referenciar a les nostres plantilles. Aquesta informació arriba estructurada de diferents formes i hi podem accedir de dos formes:

* Amb una convenció de noms

* Jeràrquicament

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

Unsolclic

2012-09-28T21:33:49Z

Albir:

= Introducció i Definició =

El UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL :[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2 : [http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433 : [http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...

[[File:Addnode1.png]]

* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.

[[File:Addradio1b.png]]

* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

[[File:Addradio3b.png]]

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la segutn imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
=== Kamikaze ===
=== AirOs ===
=== GuifiStation ===
=== Mikrotik ===
=== WRT-SveaSoft ===

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Així per una banda tenim les nostres dades i per l'altre un fitxer plantilla de com volem mostrar-les.

Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Utilització de Twig ===

Des de la banda del codi, per utilitzar Twig cal incloure la llibreria, carregar l'objecte i definir mínimament el seu comportament. A la [http://twig.sensiolabs.org/doc/api.html documentació oficial] hi podem trobar el següent fragment de codi :

<pre>
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
'cache' => '/path/to/compilation_cache',
));
<pre>

Per carregar una plantilla utilitzem el següent fragment:
<pre>
$template = $twig->loadTemplate('index.html');
</pre>

i finalment per establir els valors que prendran les variables a la nostra plantilla i visualitzar-la, el següent codi :
<pre>
echo $template->render(array('the' => 'variables', 'go' => 'here'));
</pre>

=== Convencions de Guifi.net disponibles a les plantilles ===

Com podem extreure de les entitats de guifi.net la informació necessària per fer una plantilla UnSolClic?

Abans de la confecció de l'UnSolclic s'inicialitzen unes variables que contenen tota la informació de les entitats necessàries per tal que la poguem referenciar a les nostres plantilles. Aquesta informació arriba estructurada de diferents formes i hi podem accedir de dos formes:

* Amb una convenció de noms

* Jeràrquicament

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

Unsolclic

2012-09-28T19:24:14Z

Albir:

= Introducció i Definició =

El UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL :[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2 : [http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433 : [http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...

[[File:Addnode1.png]]

* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.

[[File:Addradio1b.png]]

* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

[[File:Addradio3b.png]]

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la segutn imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
=== Kamikaze ===
=== AirOs ===
=== GuifiStation ===
=== Mikrotik ===
=== WRT-SveaSoft ===

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Així per una banda tenim les nostres dades i per l'altre un fitxer plantilla de com volem mostrar-les.

Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Utilització de Twig ===

Des de la banda del codi, per utilitzar Twig cal incloure la llibreria, carregar l'objecte i definir mínimament el seu comportament. A la [http://twig.sensiolabs.org/doc/api.html documentació oficial] hi podem trobar el següent fragment de codi :

<pre>
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
'cache' => '/path/to/compilation_cache',
));
<pre>

Per carregar una plantilla utilitzem el següent fragment:
<pre>
$template = $twig->loadTemplate('index.html');
</pre>

i finalment per establir els valors que prendran les variables a la nostra plantilla i visualitzar-la, el següent codi :
<pre>
echo $template->render(array('the' => 'variables', 'go' => 'here'));
</pre>

=== Convencions de Guifi.net disponibles a les plantilles ===

Com podem extreure de les entitats de guifi.net la informació necessària per confeccionar un fitxer UnSolClic.

En la confecció de l'UnSolclic s'inicialitza en unes variables que contenen tota la informació estructurada per tal que la poguem referenciar a les nostres plantilles.

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

Unsolclic

2012-09-28T19:02:46Z

Albir:

= Introducció i Definició =

El UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL :[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2 : [http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433 : [http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...
[[File:Addnode1.png]]
* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.
[[File:Addradio1b.png]]
* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran
[[File:Addradio3b.png]]

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la segutn imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
=== Kamikaze ===
=== AirOs ===
=== GuifiStation ===
=== Mikrotik ===
=== WRT-SveaSoft ===

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Convencions de Guifi.net disponibles a les plantilles ===

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

Unsolclic

2012-09-28T18:58:13Z

Albir:

= Introducció i Definició =

El UnsolClic és una eina per configurar els aparells que formen part de la xarxa [http://guifi.net Guifi.net] i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul [https://gitorious.org/guifi/drupal-guifi Drupal-Guifi], tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL
[[http://guifi.net/ca/guifi/device/315/view/unsolclic UnSolclic DD-Guifi] del node [http://guifi.net/ca/node/1589 Gurb Castell]
** Nanostation 2
[http://guifilocal/ca/guifi/device/26702/view/unsolclic AirOS 2.0] del node [http://guifilocal/ca/guifi/device/26702 TRSANord80Rd1]
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433
[http://guifilocal/ca/guifi/device/30084/view/unsolclic RouterOS 4.0+] del node [http://guifilocal/ca/guifi/device/30084 TRSASocietatNord]

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels [https://guifi.net/ca/connectar_a_guifi tres passos per connectar], que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...
* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.
* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la segutn imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
=== Kamikaze ===
=== AirOs ===
=== GuifiStation ===
=== Mikrotik ===
=== WRT-SveaSoft ===

= Afegir suport per a nous aparells =

== Idea general ==

L'objectiu és millorar el procés d'incorporació de nous dispositius a l'aplicació actual. Mitjançant una nova gestió web i un sistema de plantilles estándard, els usuaris avançats podràn crear els configuradors 'UnSolClic' per als nous dispositius del mercat i mantenir els existents amb més facilitat i eficiència.

== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==

* Llistat
[[File:Manufacturer1.png]]

* Formulari
[[File:Manufacturer2.png]]

== Creació de Models ==

Llistat
* [[File:models1b.png]]

Formulari
* [[File:models2c.png]]

== Creació de Firmwares ==

Llistat
* [[File:firmware1b.png]]

Formulari
* [[File:firmware2b.png]]

== Creació de Plantilles UnsolClic ==

Llistat
* [[File:unsolclic1b.png]]

Formulari
* [[File:unsolclic2b.png]]

=== Motor de plantilles Twig ===

En la majoria de les webs actuals trobem que, per facilitar el manteniment i l'optimització de codi, es busca la manera de separar la presentació del contingut, el patró de disseny del [http://es.wikipedia.org/wiki/ModeloVistaControlador Model-Vista-Controlador] és el més utilitzat en la majoria de frameworks actuals. Per implementar la capa de presentació és molt útil recórrer a un motor de plantilles estàndard que ens faciliti la feina. En el nostre sistema utilitzarem [http://twig.sensiolabs.org/ Twig] per la seva potència i simplicitat.Les seves característiques principals són les següents:
* Orígen : Symfony 2 Framework - Llicència : BSD
* Substitució de variables, filtres de text i crida de funcions natives.
* Estructures de control de flux
* Inclusió de fitxers i catxé per augment de rendiment
* Herència de plantilles
* Extensions, plugins i sandbox

=== Sintaxi de Twig ===

La sintaxi de Twig s'ha pensat per ser fàcil de fer servir i ràpida. Bàsicament, una plantilla és un fitxer de text en el que hi trobem variables o expressions i etiquetes que en controlen la lògica.

Per mostrar el contingut d'una variable o expressió utilitzem la següent sintaxi :
{{ variable }}

Per utilitzar etiquetes de control, utilitzarem
{% set buffer = 'un string amb quelcom' %}

En el següent exemple de plantilla podem veure diferents exemples de la sintaxi de Twig
<pre>
{# hello comment! #}
{{ foo.bar }} {% set foo = 'foo' %}
{{ name|striptags|title }}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}
</pre>
A la documentació oficial de Twig podem veure [http://twig.sensiolabs.org/doc/templates.html més casos]

=== Convencions de Guifi.net disponibles a les plantilles ===

=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

Unsolclic

2012-09-28T18:36:38Z

Albir:

Unsolclic

2012-09-28T18:12:11Z

Albir:

= Introducció i Definició =

El UnsolClic és una eina per configurar els aparells que formen part de la xarxa http://guifi.net i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul Drupal-Guifi, tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL
** Nanostation 2
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels tres passos per connectar, que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...
* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.
* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la segutn imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
=== Kamikaze ===
=== AirOs ===
=== GuifiStation ===
=== Mikrotik ===
=== WRT-SveaSoft ===

= Afegir suport per a nous aparells =

== Idea general ==
== Diagrama de fluxe del procés ==

En el següent diagrama, partint de la situació inicial que veiem a la part superior esquerra, es mostra el procés a seguir per poder generar l'UnSolclic per a un aparell nou

[[File:Diagrama fluxe2.png]]

== Creació de Fabricants ==
== Creació de Models ==
== Creació de Firmwares ==
== Creació de Plantilles UnsolClic ==
=== Motor de plantilles Twig ===
=== Orígens de dades ===
=== Convencions per a les plantilles ===
=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

Unsolclic

2012-09-28T18:07:47Z

Albir:

= Introducció i Definició =

El UnsolClic és una eina per configurar els aparells que formen part de la xarxa http://guifi.net i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul Drupal-Guifi, tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL
** Nanostation 2
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels tres passos per connectar, que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...
* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.
* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==

En la segutn imatge es pot veure l'esquema de les taules de les entitats involucreades en la generació del fitxer UnSolClic:

[[File:TaulesUnSolclic2.png]]

== Families de Casos actuals ==
=== Kamikaze ===
=== AirOs ===
=== GuifiStation ===
=== Mikrotik ===
=== WRT-SveaSoft ===

= Afegir suport per a nous aparells =

== Idea general ==
== Diagrama de fluxe del procés ==
== Creació de Fabricants ==
== Creació de Models ==
== Creació de Firmwares ==
== Creació de Plantilles UnsolClic ==
=== Motor de plantilles Twig ===
=== Orígens de dades ===
=== Convencions per a les plantilles ===
=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

Mapa del codi

2012-09-28T18:01:22Z

Albir:

= Introducció =

Aquest document pretén documentar la estructura del codi PHP del mòdul Drupal-guifi que aporta gran part de la funcionalitat qeu trobem a la web http://guifi.net

= Dependències =
Les dependencies son les següents:
PHP 4.4.0 o superior (5.2 recomanat)
MySQL 4.1
Drupal 6.x

= Instal·lació =
Per instalar el mòdul primer ens cal tenir un Drupal on instalar-hi el mòdul. Aquí hi ha una recepta per aconseguir un entorn de desenvolupament complet

[http://es.wiki.guifi.net/wiki/Preparando_el_entorno_de_desarrollo Preparando el Entorno de Desarrollo]

= Estructura de carpetes =
Després de la instal·lació hem de tenir el codi del mòdul a la carpeta següent de la nostra
/sites/all/modules/guifi

A dins d'aquesta hi trobarem els següents directoris

<pre>
├── contrib
│ ├── api_client
│ ├── api_doc
│ ├── drupal-patches
│ ├── fonts
│ ├── lang
│ ├── phplot
│ ├── Template
│ └── Twig
├── firmware
├── icons
├── js
├── libs
└── translations
</pre>

= Llistat de fitxers =

A l'arrel del mòdul hi trobem els següents fitxers :

<pre>
├── GeoCalc.class.php
├── guifi_ahah.inc.php
├── guifi_api.inc.php
├── guifi_cnml.inc.php
├── guifi_cron.inc.php
├── guifi.css
├── guifi_csvproxy.inc.php
├── guifi_devel.inc.php
├── guifi_devices.inc.php
├── guifi_domains.inc.php
├── guifi_gml.inc.php
├── guifi_graphs.inc.php
├── guifi_heights.php
├── guifi_hosts.inc.php
├── guifi_includes.inc.php
├── guifi.info
├── guifi.install
├── guifi_interfaces.inc.php
├── guifi_ipv4.inc.php
├── guifi_links.inc.php
├── guifi_maps.inc.php
├── guifi.module
├── guifi_networkutils.inc.php
├── guifi_node.inc.php
├── guifi_nodexchange.inc.php
├── guifi-proxy.spec
├── guifi_radios.inc.php
├── guifi_routingmap.inc.php
├── guifi_service.inc.php
├── guifi_spatial.inc.php
├── guifi_sql.inc.php
├── guifi_stats.inc.php
├── guifi_tools.inc.php
├── guifi_traceroute.inc.php
├── guifi_unsolclic.inc.php
├── guifi_users.inc.php
├── guifi_zone.inc.php
</pre>

= Llibreries =

El mòdul de Drupal-Guifi utilitza les següents llibreries:
# [http://www.phplot.com/ Phplot]
# [http://twig.sensiolabs.org/ Twig]

= Mapa de URLs definides =

= Entitats =

Mapa del codi

2012-09-28T17:59:20Z

Albir:

= Introducció =

Aquest document pretén documentar la estructura del codi PHP del mòdul Drupal-guifi que aporta gran part de la funcionalitat qeu trobem a la web http://guifi.net

= Dependències =
Les dependencies son les següents:
PHP 4.4.0 o superior (5.2 recomanat)
MySQL 4.1
Drupal 6.x

= Instal·lació =
Per instalar el mòdul primer ens cal tenir un Drupal on instalar-hi el mòdul. Aquí hi ha una recepta per aconseguir un entorn de desenvolupament complet

[http://es.wiki.guifi.net/wiki/Preparando_el_entorno_de_desarrollo Preparando el Entorno de Desarrollo]

= Estructura de carpetes =
Després de la instal·lació hem de tenir el codi del mòdul a la carpeta següent de la nostra
/sites/all/modules/guifi

A dins d'aquesta hi trobarem els següents directoris

<pre>
├── contrib
│ ├── api_client
│ ├── api_doc
│ ├── drupal-patches
│ ├── fonts
│ ├── lang
│ ├── phplot
│ ├── Template
│ └── Twig
├── firmware
├── icons
├── js
├── libs
└── translations
</pre>

= Llistat de fitxers =

A l'arrel del mòdul hi trobem els següents fitxers :

<pre>
├── GeoCalc.class.php
├── guifi_ahah.inc.php
├── guifi_api.inc.php
├── guifi_cnml.inc.php
├── guifi_cron.inc.php
├── guifi.css
├── guifi_csvproxy.inc.php
├── guifi_devel.inc.php
├── guifi_devices.inc.php
├── guifi_domains.inc.php
├── guifi_gml.inc.php
├── guifi_graphs.inc.php
├── guifi_heights.php
├── guifi_hosts.inc.php
├── guifi_includes.inc.php
├── guifi.info
├── guifi.install
├── guifi_interfaces.inc.php
├── guifi_ipv4.inc.php
├── guifi_links.inc.php
├── guifi_maps.inc.php
├── guifi.module
├── guifi_networkutils.inc.php
├── guifi_node.inc.php
├── guifi_nodexchange.inc.php
├── guifi-proxy.spec
├── guifi_radios.inc.php
├── guifi_routingmap.inc.php
├── guifi_service.inc.php
├── guifi_spatial.inc.php
├── guifi_sql.inc.php
├── guifi_stats.inc.php
├── guifi_tools.inc.php
├── guifi_traceroute.inc.php
├── guifi_unsolclic.inc.php
├── guifi_users.inc.php
├── guifi_zone.inc.php
</pre>

= Llibreries =

El mòdul de Drupal-Guifi utilitza les següents llibreries:

# Phplot
# Twig

= Mapa de URLs definides =

totes? algo més gràfic?

= Entitats =

Mapa del codi

2012-09-28T17:58:31Z

Albir:

= Introducció =

Aquest document pretén documentar la estructura del codi PHP del mòdul Drupal-guifi que aporta gran part de la funcionalitat qeu trobem a la web http://guifi.net

= Dependències =
Les dependencies son les següents:
PHP 4.4.0 o superior (5.2 recomanat)
MySQL 4.1
Drupal 6.x

= Instal·lació =
Per instalar el mòdul primer ens cal tenir un Drupal on instalar-hi el mòdul. Aquí hi ha una recepta per aconseguir un entorn de desenvolupament complet

[http://es.wiki.guifi.net/wiki/Preparando_el_entorno_de_desarrollo Pepa]

= Estructura de carpetes =
Després de la instal·lació hem de tenir el codi del mòdul a la carpeta següent de la nostra
/sites/all/modules/guifi

A dins d'aquesta hi trobarem els següents directoris

<pre>
├── contrib
│ ├── api_client
│ ├── api_doc
│ ├── drupal-patches
│ ├── fonts
│ ├── lang
│ ├── phplot
│ ├── Template
│ └── Twig
├── firmware
├── icons
├── js
├── libs
└── translations
</pre>

= Llistat de fitxers =

A l'arrel del mòdul hi trobem els següents fitxers :

<pre>
├── GeoCalc.class.php
├── guifi_ahah.inc.php
├── guifi_api.inc.php
├── guifi_cnml.inc.php
├── guifi_cron.inc.php
├── guifi.css
├── guifi_csvproxy.inc.php
├── guifi_devel.inc.php
├── guifi_devices.inc.php
├── guifi_domains.inc.php
├── guifi_gml.inc.php
├── guifi_graphs.inc.php
├── guifi_heights.php
├── guifi_hosts.inc.php
├── guifi_includes.inc.php
├── guifi.info
├── guifi.install
├── guifi_interfaces.inc.php
├── guifi_ipv4.inc.php
├── guifi_links.inc.php
├── guifi_maps.inc.php
├── guifi.module
├── guifi_networkutils.inc.php
├── guifi_node.inc.php
├── guifi_nodexchange.inc.php
├── guifi-proxy.spec
├── guifi_radios.inc.php
├── guifi_routingmap.inc.php
├── guifi_service.inc.php
├── guifi_spatial.inc.php
├── guifi_sql.inc.php
├── guifi_stats.inc.php
├── guifi_tools.inc.php
├── guifi_traceroute.inc.php
├── guifi_unsolclic.inc.php
├── guifi_users.inc.php
├── guifi_zone.inc.php
</pre>

= Llibreries =

El mòdul de Drupal-Guifi utilitza les següents llibreries:

# Phplot
# Twig

= Mapa de URLs definides =

totes? algo més gràfic?

= Entitats =

Unsolclic

2012-09-28T17:57:46Z

Albir:

= Introducció i Definició =

El UnsolClic és una eina per configurar els aparells que formen part de la xarxa http://guifi.net i un dels factors clau per al seu creixement i expansió. Pren la forma d'un fitxer de text que correspòn a una sequència d'ordres escrita en el llenguatge acceptat per el aparell que utilitzem per connectar a la xarxa lliure guifi.net.

Aquest document vol descriure, des de la vessant del desenvolupament del mòdul Drupal-Guifi, tots els processos involucrats en la confecció del UnsolClic

== Fortaleses i Febleses ==
* Fortaleses
** Aïlla a l'usuari de la configuració del trasto
** Actua com a backup de la configuració
** Fa visibles les configuraciós dels trastos per a tots els usuaris
** Dona consistencia a la xarxa
* Febleses
** Ha de generar codi en diferents llenguatges per a diferents dispositius, per tant s'ha de conèixer mímimament aquests llenguatges
** La incorporació de dispositius nous requereix aquesta codificació i porta temps.
** És genera a l'instant i no fa cache ni manté control de versions

== Exemples ==
* Nodes Client
** Linksys WRT54GL
** Nanostation 2
* Supernodes
** Linksys WRT54GL
** RouterBoard RB433

= Procés de Generació =

== La recepta dels tres passos per connectar ==

Abans de generar el UnSolClic cal que completem a la web de guifi.net la recepta dels tres passos per connectar, que ens proporcionarà tota la informació imprescindible, bàsicament
* 1. Crear un node, defineix el nom del node, la zona de la que hereta configuracions, etc...
* 2. Crear un trasto, defineix totes les propietats del nostre aparelli el firmware que executa, així com dades identificatives del nostre trasto.
* 3. Crear un enllaç, defineix quines seran les connexions del nostre node, l'adreça IP assignada i quins protocols d'enrutament s'utilitzaran

== Fitxers involucrats (per ordre d'execució) ==
<pre>
├── guifi.module : Definició de rutes
├── guifi_unsolclic.inc.php : Execució Ruta UnSolclic, preparació de dependencies, generació Unsolclic
├── guifi_includes.inc.php : Funcions diverses de guifi.
├── guifi_node.inc.php : Càrrega de la informació del node
├── guifi_devices.inc.php : Càrrega de la informació del trasto
├── guifi_radios.inc.php : Càrrega de la informació de la radio
├── guifi_interfaces.inc.php : Càrrega de la informació de les interfaces
├── guifi_ipv4.inc.php : Càrrega de la informació de les adreces ip
├── guifi_links.inc.php : Càrrega de la informació dels enllaços
</pre>

== Entitats involucrades ==
* Zona, la més específica de les diferents zones de la xarxa guifi.net on volem connectar, és a dir, que no tingui altres subzones
* Node, la ubicació concreta des d'on volem connectar.
** Trasto (device), l'aparell que utilitzarem per realitzar la connexió ( un node pot tenir més de un trasto i de diferents tipus)
** Radio , el dispositiu inalàmbric que utilitza el nostre trasto per establir una connexió física ( per enllaçar es requereix almenys una radio)
** Interface , el nom mitjançant el qual interactuem amb la radio (n'hi pot haver vàries per cada radio)
** IPV4 , cadascuna de les adreces IP que reben les interfaces.
** Enllaços (links) , cadascuna de les connexions del nostre trasto amb altres trastos propers (poden ser wireless o per cable).
* Fabricant, la casa comercial que ven el trasto
* Model, la denominació pròpia del fabricant per a determinar el trasto
* Firmware, el programari intern que executa el trasto per realitzar totes les seves funcions (pot ser propietat del Fabricant, de tercers o de Programari Lliure)

== Esquema de la Base de Dades ==
== Families de Casos actuals ==
=== Kamikaze ===
=== AirOs ===
=== GuifiStation ===
=== Mikrotik ===
=== WRT-SveaSoft ===

= Afegir suport per a nous aparells =

== Idea general ==
== Diagrama de fluxe del procés ==
== Creació de Fabricants ==
== Creació de Models ==
== Creació de Firmwares ==
== Creació de Plantilles UnsolClic ==
=== Motor de plantilles Twig ===
=== Orígens de dades ===
=== Convencions per a les plantilles ===
=== Edició de plantilles UnSolclic ===
=== Validació de plantilles UnSolclic ===

Unsolclic

2012-09-12T21:38:02Z

Albir: Es crea la pàgina amb «= Introducció i Definició = El UnsolClic és una eina per configurar els aparells que formen part de la xarxa http://guifi.net i un dels factors clau per al seu cre...».

Mapa del codi

2012-09-12T21:09:11Z

Albir:

= Introducció =

Aquest document pretén documentar la estructura del codi PHP del mòdul Drupal-guifi que aporta gran part de la funcionalitat qeu trobem a la web http://guifi.net

= Dependències =
Les dependencies son les següents:
PHP 4.4.0 o superior (5.2 recomanat)
MySQL 4.1
Drupal 6.x

= Instal·lació =
Per instalar el mòdul primer ens cal tenir un Drupal on instalar-hi el mòdul. Aquí hi ha una recepta per aconseguir un entorn de desenvolupament complet

[http://es.wiki.guifi.net/wiki/Preparando_el_entorno_de_desarrollo Pepa]

= Estructura de carpetes =
Després de la instal·lació hem de tenir el codi del mòdul a la carpeta següent de la nostra
/sites/all/modules/guifi

A dins d'aquesta hi trobarem els següents directoris

<pre>
├── contrib
│   ├── api_client
│   ├── api_doc
│   ├── drupal-patches
│   ├── fonts
│   ├── lang
│   ├── phplot
│   ├── Template
│   └── Twig
├── firmware
├── icons
├── js
├── libs
└── translations
</pre>

= Llistat de fitxers

A l'arrel del mòdul hi trobem els següents fitxers :

<pre>
├── GeoCalc.class.php
├── guifi_ahah.inc.php
├── guifi_api.inc.php
├── guifi_cnml.inc.php
├── guifi_cron.inc.php
├── guifi.css
├── guifi_csvproxy.inc.php
├── guifi_devel.inc.php
├── guifi_devices.inc.php
├── guifi_domains.inc.php
├── guifi_gml.inc.php
├── guifi_graphs.inc.php
├── guifi_heights.php
├── guifi_hosts.inc.php
├── guifi_includes.inc.php
├── guifi.info
├── guifi.install
├── guifi_interfaces.inc.php
├── guifi_ipv4.inc.php
├── guifi_links.inc.php
├── guifi_maps.inc.php
├── guifi.module
├── guifi_networkutils.inc.php
├── guifi_node.inc.php
├── guifi_nodexchange.inc.php
├── guifi-proxy.spec
├── guifi_radios.inc.php
├── guifi_routingmap.inc.php
├── guifi_service.inc.php
├── guifi_spatial.inc.php
├── guifi_sql.inc.php
├── guifi_stats.inc.php
├── guifi_tools.inc.php
├── guifi_traceroute.inc.php
├── guifi_unsolclic.inc.php
├── guifi_users.inc.php
├── guifi_zone.inc.php
</pre>

= Llibreries =

El mòdul de Drupal-Guifi utilitza les següents llibreries:

# Phplot
# Twig

= Mapa de URLs definides =

totes? algo més gràfic?

= Entitats =

Mapa del codi

2012-09-12T21:08:40Z

Albir: Es crea la pàgina amb «= Introducció = Aquest document pretén documentar la estructura del codi PHP del mòdul Drupal-guifi que aporta gran part de la funcionalitat qeu trobem a la web ht...».

= Introducció =

Aquest document pretén documentar la estructura del codi PHP del mòdul Drupal-guifi que aporta gran part de la funcionalitat qeu trobem a la web http://guifi.net

= Dependències =
Les dependencies son les següents:
PHP 4.4.0 o superior (5.2 recomanat)
MySQL 4.1
Drupal 6.x

= Instal·lació =
Per instalar el mòdul primer ens cal tenir un Drupal on instalar-hi el mòdul. Aquí hi ha una recepta per aconseguir un entorn de desenvolupament complet

[http://es.wiki.guifi.net/wiki/Preparando_el_entorno_de_desarrollo Pepa]

= Estructura de carpetes =
Després de la instal·lació hem de tenir el codi del mòdul a la carpeta següent de la nostra
/sites/all/modules/guifi

A dins d'aquesta hi trobarem els següents directoris

<pre>
├── contrib
│   ├── api_client
│   ├── api_doc
│   ├── drupal-patches
│   ├── fonts
│   ├── lang
│   ├── phplot
│   ├── Template
│   └── Twig
├── firmware
├── icons
├── js
├── libs
└── translations
</pre>

= Llistat de fitxers

A l'arrel del mòdul hi trobem els següents fitxers :

<pre>
├── GeoCalc.class.php
├── guifi_ahah.inc.php
├── guifi_api.inc.php
├── guifi_cnml.inc.php
├── guifi_cron.inc.php
├── guifi.css
├── guifi_csvproxy.inc.php
├── guifi_devel.inc.php
├── guifi_devices.inc.php
├── guifi_domains.inc.php
├── guifi_gml.inc.php
├── guifi_graphs.inc.php
├── guifi_heights.php
├── guifi_hosts.inc.php
├── guifi_includes.inc.php
├── guifi.info
├── guifi.install
├── guifi_interfaces.inc.php
├── guifi_ipv4.inc.php
├── guifi_links.inc.php
├── guifi_maps.inc.php
├── guifi.module
├── guifi_networkutils.inc.php
├── guifi_node.inc.php
├── guifi_nodexchange.inc.php
├── guifi-proxy.spec
├── guifi_radios.inc.php
├── guifi_routingmap.inc.php
├── guifi_service.inc.php
├── guifi_spatial.inc.php
├── guifi_sql.inc.php
├── guifi_stats.inc.php
├── guifi_tools.inc.php
├── guifi_traceroute.inc.php
├── guifi_unsolclic.inc.php
├── guifi_users.inc.php
├── guifi_zone.inc.php
</pre>

= Llibreries =

El mòdul de Drupal-Guifi utilitza les següents llibreries:

# Phplot
# Twig

= Mapa de URLs definides =

totes? algo més gràfic?

= Entitats