# sample php app

### Getting started with a sample php app on Eenos

This guide will help you to create a sample php app for the Eenos hosting control panel.

The PHP apps are generic php apps.

#### Download an Example PHP App

You can download an example Eenos PHP App from [here: samplephpapp.tar.gz](https://download.eenos.com/apps/sample-php-app/samplephpapp.tar.gz)

#### app.conf

The first step is to create the app.conf . An example of **samplephpapp** is given below :

```ini
[settings]
# All the settings fields are mandatory 
# The Name of the parent folder of the app.
# The name may contain letters, digits, hyphen and underscore
# The name always starts with a letter and a length of 20 characters.
name = samplephpapp

# The menu name that will be showing inside the control panel pages
#  Maximum menu name length is 24 characters.
menu = A Sample PHP App

# A description about the app. What is the use of this app ?
# Maximum length of description is 6o characters. 
description = This is a sample PHP app for testing purpose

# The programming language , currently support python or php only
# If this is a Python Django app use python
# if this is a  PHP app chose , php
# Accepted values [ python , php]
language = php

# This app version number
version = 1.0.0

# The version_check_url is a remote url shows the available current version of the app
# This url must give the version number as plain text output
# This version should ensure if the app is up-to-date
version_check_url =  https://download.eenos.com/apps/sample-php-app/version.txt

# The auto update script path used to update the scripts
# You can place this in ,/scripts/ folder so that will be installed 
auto_update = /usr/local/eenos/scripts/samplephpapp_update

[wap]
# The general settings for WAP admin app
# To enable or disable this app in admin panel 
# Supported values ,[ on , off ]
status = on

# If you wish to open the app in new browser window during a click action
# from the  control panel
# Supported values [ off,  on] , default off
open_new_window = on

[rapp]
# The general settings for RAPP - Reseller control panel app
# To enable or disable this app in reseller  panel 
# Supported values ,[ on , off ]
status = on

# If you wish to open the app in new browser window during a click action
# from the  control panel
# Supported values, [ off,  on] , default off
open_new_window = on

[uapp]
# The general settings for UAPP - User control panel app
# To enable or disable this app in user  panel 
# Supported values, [ on , off ]
status = on

# If you wish to open the app in new browser window during a click action
# from the  control panel
# Supported values [ off,  on] , default off
open_new_window = on

```

You should set the **language** with value **php** for a PHP app.

#### Files and destination of php app - samplephpapp

The following table will let you know where the files will be placed during app installation time.

<table border="1" id="bkmrk-sample-app-item-loca" style="border-collapse: collapse; width: 100%; height: 237.97px;"><colgroup><col style="width: 28.923%;"></col><col style="width: 45.8576%;"></col><col style="width: 25.2139%;"></col></colgroup><tbody><tr style="height: 29.7463px;"><td style="height: 29.7463px;">**Sample App Item**</td><td style="height: 29.7463px;">**Location to place**</td><td style="height: 29.7463px;">**Description**</td></tr><tr style="height: 29.7463px;"><td style="height: 29.7463px;">./hooks/\*</td><td style="height: 29.7463px;">/var/eenos/hooks/</td><td style="height: 29.7463px;"> All hook scripts of the app</td></tr><tr style="height: 29.7463px;"><td style="height: 29.7463px;">./scripts/\*</td><td style="height: 29.7463px;">/usr/local/eenos/scripts/</td><td style="height: 29.7463px;">All scripts of the app</td></tr><tr style="height: 29.7463px;"><td style="height: 29.7463px;">./wap/samplephpapp</td><td style="height: 29.7463px;">/usr/local/eenos/3rdparty/apps/wap/samplephpapp</td><td style="height: 29.7463px;">The admin panel plugin files</td></tr><tr style="height: 29.7463px;"><td style="height: 29.7463px;">./rapp/samplephpapp</td><td style="height: 29.7463px;">/usr/local/eenos/3rdparty/apps/rapp/samplephpapp</td><td style="height: 29.7463px;">The reseller panel plugin file</td></tr><tr style="height: 29.7463px;"><td style="height: 29.7463px;">./uapp/samplephpapp</td><td style="height: 29.7463px;">/usr/local/eenos/3rdparty/apps/uapp/samplephpapp</td><td style="height: 29.7463px;">The user panel app files</td></tr><tr style="height: 29.7463px;"><td style="height: 29.7463px;">./static/samplephpapp</td><td style="height: 29.7463px;">/usr/local/eenos/wap/public/static/default/samplephpapp</td><td style="height: 29.7463px;">Admin panel static files</td></tr><tr><td>./static/samplephpapp</td><td>/usr/local/eenos/rapp/public/static/default/samplephpapp</td><td>Reseller panel static files</td></tr><tr style="height: 29.7463px;"><td style="height: 29.7463px;">./static/samplephpapp</td><td style="height: 29.7463px;">/usr/local/eenos/uapp/public/static/default/samplephpapp</td><td style="height: 29.7463px;">User panel static file</td></tr><tr><td>./vhosts/wap.samplephpapp.conf</td><td>/usr/local/eenos/etc/eenosd/wap.samplephpapp.conf</td><td>The admin panel nginx vhost</td></tr><tr><td>./vhosts/rapp.samplephpapp.conf</td><td>/usr/local/eenos/etc/eenosd/rapp.samplephpapp.conf</td><td>Reseller panel nginx vhost</td></tr><tr><td>./vhosts/uapp.samplephpapp.conf</td><td>/usr/local/eenos/etc/eenosd/uapp.samplephpapp.conf</td><td>User panel nginx vhost</td></tr></tbody></table>

The static files are common files that will be copied into the three control panel interface static folders.

####  App folder structure 

An example folder structure of php app, samplephpapp is as follows,

```bash
# tree samplephpapp
samplephpapp
├── app.conf
├── hooks
├── LICENSE
├── post
│   └── 02-post.sh
├── pre
│   └── 01-ps.sh
├── rapp
│   └── samplephpapp
│       ├── index.php
│       └── starter-template.css
├── README
├── requirements.txt
├── scripts
│   └── samplephpapp-scripts.sh
├── static
│   └── samplephpapp
│       ├── css
│       │   ├── bootstrap.min.css
│       │   ├── bootstrap.min.css.map
│       │   ├── bootstrap.rtl.min.css
│       │   └── bootstrap.rtl.min.css.map
│       └── js
│           ├── bootstrap.bundle.min.js
│           └── bootstrap.bundle.min.js.map
├── uapp
│   └── samplephpapp
│       ├── index.php
│       └── starter-template.css
├── vhosts
│   ├── rapp.samplephpapp.conf
│   ├── uapp.samplephpapp.conf
│   └── wap.samplephpapp.conf
└── wap
    └── samplephpapp
        ├── index.php
        └── starter-template.css

```

#### Python requirements

You can place all your pip requirements for your python app inside the file **requirements.txt**

#### Pre-installation scripts

Put all your pre-installation scripts of the plugin inside the folder **pre/**

#### Post-installation scripts

Place all your post plugin installation scripts inside the folder **post/**

#### scripts

Place all scripts related to your plugin in the folder **scripts/**

#### hooks

Place all your hooks for Eenos inside the folder **hooks/**

#### Vhosts

Place all your nginx vhost files inside the folder **vhost/**

#### Manage Authentication in PHP Apps

You can authenticate the php apps using the **php pam** module or a custom preg function. The sample code is as follows,

##### PAM Authentication

```php
<?php
// Sample function to check authentication using php-pam module 
function auth_pam($user,$password){    
    if (pam_auth($user,$password)){
        return true;
    }else{       
        return false;
    }
 }
```

##### Custom Preg 

```php
<?php
 
function is_notsuspended($username){
    if (file_exists("/var/eenos/suspended/$username")){        
        return false;
    }else{        
        return true;
       
    }
}

function iseenosuer($username){
    if (file_exists("/var/eenos/users/$username")){        
        return true;
    }else{        
        return false;
    }
}

function sauthenticate($user, $pass){
    if (iseenosuer(($user))){
        if (is_notsuspended($user)){
        $shad =  preg_split("/[$:]/",`cat /etc/shadow | grep "^$user\:"`);
        if (!isset($shad[2]) || !isset($shad[3])) return false;
        $mkps = preg_split("/[$:]/",crypt($pass, '$'.$shad[2].'$'.$shad[3].'$'));         
        return ($shad[4] == $mkps[3]);
        }else{
            return false;
        }
    }
    else{
        return false;
    }   
  }
```

#### Packaging your app

To package an app create a gzip tar file of the source folder. An example of samplephpapp is as follows:

```bash
tar -czf samplephpapp-1.0.0.tar.gz samplephpapp/
```

#### Install, Remove, and Upgrade the App

To install, remove, or upgrade the app please read the app operations from<span style="color: rgb(45, 194, 107);"> **[Manage Apps](https://docs.eenos.com/books/eenos-apps-plugins/chapter/manage-apps "Manage Apps")** </span> page.