Ready for Jessie (+ some improvements)

README.md

@@ -1,6 +1,8 @@
 # PirateBox
 ## Overview
 
+**Warning: work in progress**
+
 PirateBox app for [YunoHost](http://yunohost.org/).
 
 Based on [php-piratebox](https://github.com/jvaubourg/php-piratebox).
@@ -17,10 +19,6 @@ Based on [php-piratebox](https://github.com/jvaubourg/php-piratebox).
 
 The YunoHost administration is only available through the wired connection.
 
-## Requirements
-
-You have to install the [Wifi Hotspot app for YunoHost](https://github.com/labriqueinternet/hotspot_ynh) before and disable the wifi secure access mode thanks to the friendly web interface.
-
 ## How It Works ##
 
 Explanations:
@@ -31,6 +29,12 @@ Explanations:
 4. all packets to port 80 are redirected to the port 4280,
 5. a Nginx vhost listens on the port 4280, and redirects to the PirateBox web page.
 
+## Prerequisites
+
+* Debian Jessie
+* YunoHost >= 2.2.0
+* [Hotspot app for YunoHost](https://github.com/jvaubourg/hotspot_ynh)
+
 ## Limitations ##
 
 * IPv4-only because the NAT table is not available for IPv6 before the kernel 3.9.0 and iptables 1.4.18 (not in Debian stable for now)

conf/piratebox_fakedns

@@ -25,6 +25,7 @@ sub reply_handler {
  
 my $ns = new Net::DNS::Nameserver(
   LocalPort    => 4253,
+  LocalAddr    => $ip4_addr,
   ReplyHandler => \&reply_handler,
   Verbose      => 0
   ) || die "Couldn't create fake nameserver object.\n";

conf/ynh-piratebox

@@ -90,7 +90,7 @@ set_captive() {
 
   cp /etc/nginx/{,conf.d/}captive-piratebox.conf
 
-  systemctl reload nginx --quiet
+  systemctl reload nginx
 }
 
 start_fakedns() {
@@ -119,7 +119,7 @@ unset_filt4_nofwd() {
 unset_captive() {
   rm -f /etc/nginx/conf.d/captive-piratebox.conf
 
-  systemctl reload nginx --quiet
+  systemctl reload nginx
 }
 
 stop_fakedns() {
@@ -130,26 +130,34 @@ stop_fakedns() {
 
 moulinette_get() {
   var=${1}
+  gotcha=0
 
-  value=$(yunohost app setting piratebox "${var}")
+  while [ "${gotcha}" -eq 0 ]; do
+    value=$(yunohost app setting piratebox "${var}")
 
-  if [[ "${value}" =~ "An instance is already running" ]]; then
-    echo "${value}" >&2
-    exit 1
-  fi
+    if [[ "${value}" =~ "An instance is already running" ]]; then
+      sleep $(($((RANDOM%5)) + 1))
+    else
+      gotcha=1
+    fi
+  done
 
   echo "${value}"
 }
 
 moulinette_hotspot_get() {
   var=${1}
+  gotcha=0
 
-  value=$(yunohost app setting hotspot "${var}")
+  while [ "${gotcha}" -eq 0 ]; do
+    value=$(yunohost app setting hotspot "${var}")
 
-  if [[ "${value}" =~ "An instance is already running" ]]; then
-    echo "${value}" >&2
-    exit 1
-  fi
+    if [[ "${value}" =~ "An instance is already running" ]]; then
+      sleep $(($((RANDOM%5)) + 1))
+    else
+      gotcha=1
+    fi
+  done
 
   echo "${value}"
 }
@@ -159,7 +167,20 @@ if [ "$1" != restart ]; then
   # Restart php5-fpm at the first start (it needs to be restarted after the slapd start)
   if [ ! -e /tmp/.ynh-piratebox-boot ]; then
     touch /tmp/.ynh-piratebox-boot
-    systemctl restart php5-fpm --quiet
+    systemctl restart php5-fpm
+  fi
+
+  ynh_wifi_device_id=$(moulinette_get wifi_device_id)
+
+  if [[ ! "${1}" =~ stop ]]; then
+    exitcode=0
+
+    if [ "${ynh_wifi_device_id}" -eq -1 ]; then
+      echo "[WARN] You need to select an associated wifi hotspot (you can do it through the web admin)"
+      exitcode=1
+    fi
+
+    [ "${exitcode}" -ne 0 ] && exit ${exitcode}
   fi
 
   # Variables
@@ -167,7 +188,6 @@ if [ "$1" != restart ]; then
   echo -n "Retrieving Yunohost settings... "
 
   ynh_service_enabled=$(moulinette_get service_enabled)
-  ynh_wifi_device_id=$(moulinette_get wifi_device_id)
   ynh_opt_renaming=$(moulinette_get opt_renaming)
   ynh_opt_deleting=$(moulinette_get opt_deleting)
   ynh_opt_chat=$(moulinette_get opt_chat)

conf/ynh-piratebox.service

@@ -1,15 +1,13 @@
 [Unit]
-Description=YunoHost PirteBox (ShareBox).
-Requires=network.target
-After=network.target
+Description=YunoHost PirateBox.
+Requires=ynh-hotspot.service
+After=ynh-hotspot.service
 
 [Service]
 Type=oneshot
-ExecStart=/usr/local/bin/ynh-pirtebox start
-ExecRestart=/usr/local/bin/ynh-pirtebox restart
-ExecStop=/usr/local/bin/ynh-pirtebox stop
+ExecStart=/usr/local/bin/ynh-piratebox start
+ExecStop=/usr/local/bin/ynh-piratebox stop
 RemainAfterExit=yes
 
 [Install]
 WantedBy=multi-user.target
-Alias=ynh-piratebox.service

scripts/install

@@ -57,7 +57,7 @@ sudo yunohost app setting piratebox opt_name -v "${opt_name}"
 sudo yunohost app setting piratebox opt_renaming -v "${opt_renaming}"
 sudo yunohost app setting piratebox opt_deleting -v "${opt_deleting}"
 sudo yunohost app setting piratebox opt_chat -v "${opt_chat}"
-sudo yunohost app setting piratebox wifi_device_id -v 0
+sudo yunohost app setting piratebox wifi_device_id -v -1
 
 # Install packages
 packages='php5-fpm iptables libnet-dns-perl git'
@@ -135,25 +135,25 @@ sudo sed "s|<TPL:NGINX_LOCATION>|${url_path}|g" -i /var/www/piratebox_admin/conf
 sudo install -o root -g root -m 0755 ../conf/piratebox_fakedns /usr/local/bin/
 
 # Copy init script
-sudo install -o root -g root -m 0755 ../conf/ynh-piratebox.service /lib/systemd/system/ynh-piratebox.service
 sudo install -o root -g root -m 0755 ../conf/ynh-piratebox /usr/local/bin/
+sudo install -o root -g root -m 0644 ../conf/ynh-piratebox.service /etc/systemd/system/
 
 # Update firewall
 sudo yunohost firewall allow --no-upnp UDP 4253
 sudo yunohost firewall allow --no-upnp TCP 4280
 
 # Set default inits
-sudo yunohost service add php5-fpm
-sudo yunohost service enable php5-fpm
+sudo systemctl enable php5-fpm
+sudo systemctl restart php5-fpm
 
-sudo systemctl restart php5-fpm --quiet
-sudo systemctl reload nginx --quiet
+sudo systemctl reload nginx
 
-sudo yunohost service add ynh-piratebox
-sudo yunohost service reenable ynh-piratebox
-sudo systemctl start ynh-piratebox --quiet
+sudo systemctl enable ynh-piratebox
+sudo systemctl start ynh-piratebox
 
 # Update SSO
 sudo yunohost app ssowatconf
 
+echo "WARNING: PirateBox is not started because you need to define an associated wifi hotspot through the web admin" >&2
+
 exit 0

scripts/remove

@@ -21,10 +21,9 @@
 domain=$(sudo yunohost app setting piratebox domain)
 
 # The End
-sudo systemctl stop ynh-piratebox --quiet
-sudo yunohost service remove ynh-piratebox
-sudo systemctl disable ynh-piratebox --quiet
-sudo rm -f /lib/systemd/system/ynh-piratebox.service /usr/local/bin/ynh-piratebox
+sudo systemctl stop ynh-piratebox
+sudo systemctl disable ynh-piratebox
+sudo rm -f /etc/systemd/system/ynh-piratebox.service /usr/local/bin/ynh-piratebox
 sudo rm -f /tmp/.ynh-piratebox-*
 
 # Update firewall
@@ -40,9 +39,8 @@ sudo rm -f /etc/php5/fpm/pool.d/{captive-,}piratebox.conf
 sudo rm -f /usr/local/bin/piratebox_fakedns
 
 # Restart services
-sudo yunohost service stop php5-fpm
-sudo yunohost service start php5-fpm
-sudo systemctl reload nginx --quiet
+sudo systemctl restart php5-fpm
+sudo systemctl reload nginx
 
 # Remove tmp folder
 sudo rm -rf /var/spool/piratebox/

sources/controller.php

@@ -31,17 +31,17 @@ function moulinette_hotspot_get($var) {
 }
 
 function stop_service() {
-  exec('sudo systemctl stop ynh-piratebox --quiet');
+  exec('sudo systemctl stop ynh-piratebox');
 }
 
 function start_service() {
-  exec('sudo systemctl start ynh-piratebox --quiet', $output, $retcode);
+  exec('sudo systemctl start ynh-piratebox', $output, $retcode);
 
   return $retcode;
 }
 
 function service_status() {
-  exec('sudo systemctl is-active ynh-piratebox --quiet', $output);
+  exec('sudo ynh-piratebox status', $output);
 
   return $output;
 }
@@ -69,10 +69,6 @@ dispatch('/', function() {
     $wifi_ssid_list .= "<li $active data-device-id='$i'><a href='javascript:;'>".htmlentities($ssids[$i]).'</a></li>';
   }
 
-  if(empty($wifi_ssid)) {
-    $wifi_ssid = '<em>'.T_("None").'</em>';
-  }
-
   set('faststatus', service_faststatus() == 0);
   set('service_enabled', moulinette_get('service_enabled'));
   set('wifi_device_id', $wifi_device_id);
@@ -98,6 +94,10 @@ dispatch_put('/settings', function() {
         throw new Exception(T_('The name cannot be empty'));
       }
 
+      if($_POST['wifi_device_id'] == -1) {
+        throw new Exception(T_('You need to select an associated hotspot'));
+      }
+
     } catch(Exception $e) {
       flash('error', T_('PirateBox')." $id: ".$e->getMessage().' ('.T_('configuration not updated').').');
       goto redirect;

sources/views/settings.html.php

@@ -54,11 +54,18 @@
           </div>
 
           <div class="form-group">
+            <?php if($wifi_device_id == -1): ?>
+              <div class="alert alert-dismissible alert-warning fade in" style="margin: 2px 16px 17px" role="alert">
+                <button type="button" class="close" data-dismiss="alert"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+                <strong><?= T_('Notice') ?>:</strong> <?= T_("You need to select an associated hotspot.") ?>
+              </div>
+            <?php endif; ?>
+
             <label for="wifi_device_id" class="col-sm-3 control-label"><?= T_('Associated Hotspot') ?></label>
             <div class="col-sm-9 input-group-btn">
               <div class="input-group">
                   <input type="text" name="wifi_device_id" id="wifi_device_id" value="<?= $wifi_device_id ?>" style="display: none" />
-                  <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown"><?= $wifi_ssid ?> <span class="caret"></span></button>
+                  <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown"><?= empty($wifi_ssid) ? '<em>'.T_("None").'</em>' : $wifi_ssid ?> <span class="caret"></span></button>
                   <ul class="dropdown-menu dropdown-menu-left" id="deviceidlist" role="menu">
                     <?= $wifi_ssid_list ?>
                   </ul>