FAQ & HOW TO Crear add-ons para Webadmin 2.0

FAQ & HOW TO Crear add-ons para Webadmin 2.0

Mensagempor El guapo Dan » Qua Nov 26, 2008 9:36 pm

Primero entendamos los principios.

Si estas aquí es por que ya sabes que es Webadmin 2.0, si no lo sabes por favor dirígete a:

¿Que es un add-on para Webadmin 2.0?
    Un add-on para Webadmin 2.0 es una aplicacion o programa escrito o compilado para funcionar en BFW y que tiene una interface para administrarlo remotamente mediante un navegador web como IExplorer o Firefox.

¿De que esta hecho un add-on para Webadmin 2.0?
    De cuatro cosas fundamentales
      -Primero de el programa que deseas ejecutar en BFW .
      -Segundo de una interface web mediante la cual el programa será adminstrado, esta interface web sera la que se muestre en Webadmin 2.0, esta interface estará localizada en una carpeta que tendra el nombre de tu add-on y esta estara localizada en:
      /partition/apache/webadmin2.0/add-ons/
      y será llamada necesariamente “index.php”, que el nombre index.php no te asuste, este puede contener solo codigo HTML.
      -Tercero, se necesita crear una estructura de "directorios" los cuales contendrán todos los archivos del add-on, esta estructura de directorios (o folders) será una simulacion de como se encontrarán los archivos dentro de BFW.
      -Cuarto, estos archivos que conforman el add-on deben ser "empaquetados" de una manera que Webadmin 2.0 y BFW entiendan, y esta manera es "empaquetandolos" en un archivo TGZ que es un tipo de archivo comprimido con TAR y GZIP al mismo tiempo.

      No te preocupes si no entiendes muy bien alguno de los puntos, de cualquier manera seran explicados mas a fondo mas adelante, solo trata de grabarte bien en la mente que un add-on es una manera de instalar nuevas funcionalidades a BFW y que necesitan crearse de una manera muy especifica.

¿Qué necesito para crear una interface web para mi add-on?
    Conocimientos de HTML, y si quieres que tu interface sea mas robusta PHP.

¿Que tipo de archivos reconoce Webadmin 2.0 como interface de add-on?
    index.php

¿Con que tipo de programas puedo crear un add-on para BFW?
    Con programas compilados para BFW y con scripts en PHP.

¿Como puedo compilar una aplicacion que siempre he deseado tener en BFW?

¿Como instala los add-ons Webadmin 2.0 en mi BFW?
    Utiliza Add-on installer el cual primero sube el .tgz a una locacion temporal en tu BFW, luego descomprime el add-on lo cual instala los archivos en las carpetas necesarias, por ello es importante la estructura de directorios que viene en el .tgz, registra el add-on en una base de datos y luego borra el archivo tgz del add-on.

¿Podrias mostrar algun ejemplo de creacion de add-ons para BFW?
    Claro:

    Ejemplo , script PHP simple:

      LA APLICACION Y LA INTERFACE
        Este add-on consta de un único script PHP que al mismo tiempo es la aplicacion y la interface web.

        Es una aplicacion para ejecutar cualquier comando en tu BFW, por favor toma en cuenta los peligros que ello representa.

        Abre tu editor de textos simple favorito como: gedit, vim, notepad... etc, no puedes usar procesadores de textos como word o wordpad.

        Escribe el siguiente código:
        Código: Selecionar todos
        <?php
            include('/partition/apache/webadmin2.0/webfunctions.php');
            TopSide('My cool first add-on is an executer');

            if( isset($_POST['execute']) )
            {
                  $command = $_POST['command'];
                  echo shell_exec($command) . '<br />';
                  echo "Command: <b>$command</b> executed successful";
            }
            else
            {
        ?>
        <form method="POST" action="<?php echo $PHP_SELF; ?>">
            <table>
                <th>Executer 1.0</th>
                <tr class="rowA">
                    <td>Execute command</td>
                    <td><input name="command"></td>
                </tr>
                <tr class="rowB">
                    <td>
                        <input type="submit" value="Execute" name="execute" />
                    </td>
                </tr>
            </table>
        </form>
        <?php
            }
            BottomSide();
        ?>

        Ese es el codigo fuente de una aplicacion PHP que al mismo tiempo es una interface para Webadmin 2.0

        Para que un script PHP sea una interface web para Webadmin 2.0 es necesario cumplir 4 simples reglas:
          1.- El script debera extrictamente ser llamado index.php

          2.- La primera y la segunda linea de codigo deben ser estas llamadas en PHP:
          Código: Selecionar todos
           
          include('/partition/apache/webadmin2.0/webfunctions.php');
          TopSide('NAME OF TH ADD_ON');

          La primera linea es para incluir las funciones de formato y estilo necesarias para que tu interface haga armonia con Webadmin 2.0, la segunda linea es para que el navegador muestre el nombre de tu add-on en el titulo de la ventana (no es el titulo que se vera en Webadmin2.0)

          3.-NO debes incluir el siguiente codigo de HTML :
          Código: Selecionar todos
          <html>
              <head>
              </head>
              <style>
              </style>
              <body>
              </body>
          </html>

          Debes crear tu pagina solo con el codigo que va entre <body> y </body>

          4.- La ultima linea de codigo sera esta llamada en PHP:
          Código: Selecionar todos
          BottomSide();

          Esta linea es la que termina de armar la interface.
      ARMANDO EL ADD-ON
        Como ya se menciono los archivos que conforman el add-on deben ser "empaquetados" de una manera que Webadmin 2.0 y BFW entiendan y ademas se necesita crear una estructura de "directorios" los cuales contendrán todos los archivos del add-on, esta estructura de directorios (o folders) será una simulacion de como se encontrarán los archivos dentro de BFW.

        En resumen, crearemos una "estructura de directorios" que "empaquetaremos" en un archivo que Webadmin 2.0 entienda o sea en un .tgz.

        La estructura de directorios necesaria para que tu add-on pase a ser parte del Webadmin 2.0 es la siguiente:
        Código: Selecionar todos
        /partition/apache/webadmin2.0/add-ons/NombreDelAddon

        Entonces vamos a crear:
          Una carpeta llamada partition que a su vez contenga
          Una carpeta llamada apache que a su vez contenga
          Una carpeta llamada webadmin2.0 que a su vez contenga
          Una carpeta llamada add-ons que a su vez contenga
          Una carpeta llamada NombreDelAddon que a su vez contenga (Nota: el nombre de esta carpeta será el nombre de que se mostrará en el menu de Webadmin2.0)
          El index.php

          Cuando tengas lista la estructura de directorios con los ejecutables adentro y el index.php en la carpeta NombreDelAddon comprime el directorio partition en un tgz con el nombre que quieras, normalmente el nombre es el nombre del add-on, lo comprimiras con el siguiente comando:
          Código: Selecionar todos
          tar -czvf  NombreDelAddOn.tgz partition



        Y con esto tu add-on esta listo para instalarse con el add-on installer


EN CONSTRUCCION
El guapo Dan
 

Voltar para BrazilFW 2.x

Quem está online

Usuários navegando neste fórum: Nenhum usuário registrado e 1 visitante