Drupal 7

Drupal 7 with Drush Loader and Non-Composer Project

nigel — Tue, 09 Oct 2018 19:59:27 +0000

Drupal 7 with Drush Loader and Non-Composer Project nigel Tue, 09/10/2018 - 20:59

I've just upgraded my bare-metal Linux server which host many of my Drupal projects. My main driver was to get it up to PHP 7.1. I also in that process I elected to replace the existing /usr/local/bin/drush command with the drush loader which automatically runs project-based drush commands installed by composer into the vendor directory.

The problem with this approach of course is if you have Drupal 7 virtual hosts which were built without composer, then they would lose drush capability. Thankfully there is a simple workaround for this - by retrospectively adding a skeleton composer.json file to the project.

The Current Situation

I change directory into one of my many D7 projects

$ cd /var/www/html/tube
$ drush
The Drush launcher could not find a Drupal site to operate on. Please do *one* of the following:
  - Navigate to any where within your Drupal project and try again.
  - Add --root=/path/to/drupal so Drush knows where your site is located.

This is the diagnostic you will receive if you attempt to run drush in a non-composer project.

The composer.json Skeleton

Now we have to add our composer skeleton to our project. So in your favourite editor add:
composer.json

{
    "require": {
        "drush/drush": "~8"
    },
    "extra": {
        "installer-paths": {
            ".": ["type:drupal-core"]
        }
    }
}

Most of this will be self-evident to composer users. The "drush/drush": "~8" means the version of drush should be kept at 8 with minor version increases allowed. The installer paths "." option basically means install the vendor directory that will house the drush binaries in the current directory. The reason is simple: I created this particular project long before child www or docroot directories became the norm.

Composer Install

Once the json file has been created, we are ready to go.

$ composer install
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 20 installs, 0 updates, 0 removals
..
snipped
...
drush/drush suggests installing drush/config-extra (Provides configuration workflow commands, such as config-merge.)
Writing lock file
Generating autoload files
<code>

Vendor Directory

The vendor directory will now have been created and can be witnessed with

$ ls -las vendor
total 60
4 drwxrwxr-x 14 nigel www-data 4096 Oct  9 21:22 .
4 drwxrwxr-x 11 nigel www-data 4096 Oct  9 21:21 ..
4 -rw-rw-r--  1 nigel www-data  178 Oct  9 21:22 autoload.php
4 drwxrwxr-x  2 nigel www-data 4096 Oct  9 21:21 bin
4 drwxrwxr-x  2 nigel www-data 4096 Oct  9 21:21 composer
4 drwxrwxr-x  4 nigel www-data 4096 Oct  9 21:21 consolidation
4 drwxrwxr-x  3 nigel www-data 4096 Oct  9 21:21 dnoegel
4 drwxrwxr-x  3 nigel www-data 4096 Oct  9 21:21 drush
4 drwxrwxr-x  4 nigel www-data 4096 Oct  9 21:21 jakub-onderka
4 drwxrwxr-x  3 nigel www-data 4096 Oct  9 21:21 nikic
4 drwxrwxr-x  3 nigel www-data 4096 Oct  9 21:21 pear
4 drwxrwxr-x  3 nigel www-data 4096 Oct  9 21:21 psr
4 drwxrwxr-x  3 nigel www-data 4096 Oct  9 21:21 psy
4 drwxrwxr-x 10 nigel www-data 4096 Oct  9 21:21 symfony
4 drwxrwxr-x  4 nigel www-data 4096 Oct  9 21:21 webmozart

Running drush status

Ok so now we should be good to go. Let's try it out!

$ drush status
 Drupal version                  :  7.59                                            
 Site URI                        :  http://default                                  
 Database driver                 :  mysql                                           
 Database hostname               :  127.0.0.1                                       
 Database port                   :                                                  
 Database username               :  drupal                                          
 Database name                   :  xxxx                                            
 Database                        :  Connected                                       
 Drupal bootstrap                :  Successful                                      
 Drupal user                     :                                                  
 Default theme                   :  xxxx                                  
 Administration theme            :  seven                                           
 PHP executable                  :  /usr/bin/php                                    
 PHP configuration               :  /etc/php/7.0/cli/php.ini                        
 PHP OS                          :  Linux                                           
 Drush script                    :  /var/www/html/xxxx/vendor/drush/drush/drush.php 
 Drush version                   :  8.1.17                                          
 Drush temp directory            :  /tmp                                            
 Drush configuration             :                                                  
 Drush alias files               :                                                  
 Install profile                 :  standard                                        
 Drupal root                     :  /var/www/html/xxxx                              
 Drupal Settings File            :  sites/default/settings.php                      
 Site path                       :  sites/default                                   
 File directory path             :  sites/default/files                             
 Temporary file directory path   :  /tmp

Good to go! We are done here!

blog terms

Drupal Drupal 7 Drupal 8 Development

Drupal 8 and DRUD Tech's ddev Local Development Environment

nigel — Sat, 10 Mar 2018 21:12:50 +0000

Drupal 8 and DRUD Tech's ddev Local Development Environment nigel Sat, 10/03/2018 - 21:12

My favourite presentation at DrupalCamp London 2018 was Turbocharge Your Agency given by DRUD Tech co-founder Kevin Bridges and Jeffrey A. "jam" McGuire. They talked at length about the container solution ddev which enables developers to manage their local environments and thus optimise their time and in addition save their configuration under source control. Furthermore the demonstration showed that it was possible to flip between different configurations with different Drupal versions easily and quickly. The solution found here uses Docker and is wrapped by the lightning fast Golang.

I've been thinking for a while about moving from my existing hand crafted Virtual Machine towards Docker. My VM's configuration isn't under source control management, and has built up over the years into quite a complex beast. I have Jenkins, phing, composer, Drupal console, Mail Catcher, Compass, node, npm, Python, nginx, Apache, MariaDB and MongoDB that I can remember off the top of my head. It's becoming a difficult proposition to keep it all working. When I need to run a different version of PHP I manually switch simlinks around. Oh for something easier.

So I elected to investigate whether Drud Tech's offering could possibly help out. The demonstration given by their guys at DrupalCamp London 2018 showed the ease of moving between D7 and D8 repos. However they were fresh builds and for the tool to be of value to me, it would have to work from pre-existing codebases.

Installing a VirtualBox VM

This was purely a Proof of Concept so as a consequence I needed to keep anything I did in a ring-fenced environment. Therefore a VirtualBox Ubuntu 16.04LTS image was used as a starting point. I won't provide screenshots of the entire build process since I have previous blogs to cover this.

Once the build has completed and I have logged in I issue a ifconfig command to determine the IP address which is 10.0.2.15 (second screenshot). This will need to be used with the network configuration.

When I was building the VM I kept the default network configuration which is NAT. I have moved away from using Bridged Adapter. A bridged adapter on the face of it is very convenient - it automatically gets an IP address via DHCP from my ISP provided router at home, in the 192.168.0.0 range. However this falls foul at client sites with security policies prohibiting unknown MAC Addresses, and Internet cafes that don't use the same IP range - it simply won't work.

The solution is to use NAT and use the port forwarding facility. Navigate to Settings -> Network -> Advanced -> Port Forwarding and add values for ssh as per the third screenshot above.

I can now ssh into the ddev VM.

$ ssh -p 2222 nigel@127.0.0.1
The authenticity of host '[127.0.0.1]:2222 ([127.0.0.1]:2222)' can't be established.
ECDSA key fingerprint is SHA256:VRNxWpagSl2DGz7dmgRjBqdDdadXITdPPkItrMR9k38.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added '[127.0.0.1]:2222' (ECDSA) to the list of known hosts.
nigel@127.0.0.1's password: 
Welcome to Ubuntu 16.04.3 LTS (GNU/Linux 4.4.0-87-generic x86_64)
 
 * Documentation:  https://help.ubuntu.com
 * Management:     https://landscape.canonical.com
 * Support:        https://ubuntu.com/advantage
 
137 packages can be updated.
69 updates are security updates.
 
 
Last login: Mon Mar  5 21:50:35 2018
To run a command as administrator (user "root"), use "sudo ".
See "man sudo_root" for details.

Install Docker

Don't be tempted to install the Docker version that is bundled in the Ubuntu default repos. Follow the instructions on the Docker site for installing the CE version of Docker from their private repo.

nigel@ddev:~$ sudo apt-get update
[sudo] password for nigel: 
Hit:1 http://security.ubuntu.com/ubuntu xenial-security InRelease
Hit:2 http://gb.archive.ubuntu.com/ubuntu xenial InRelease
Hit:3 http://gb.archive.ubuntu.com/ubuntu xenial-updates InRelease
Hit:4 http://gb.archive.ubuntu.com/ubuntu xenial-backports InRelease
Reading package lists... Done

Install packages to allow apt to use a repository over HTTPS

nigel@ddev:~$ sudo apt-get install \
>     apt-transport-https \
>     ca-certificates \
>     curl \
>     software-properties-common
Reading package lists... Done
Building dependency tree       
Reading state information... Done
apt-transport-https is already the newest version (1.2.25).
ca-certificates is already the newest version (20170717~16.04.1).
curl is already the newest version (7.47.0-1ubuntu2.6).
software-properties-common is already the newest version (0.96.20.7).
0 to upgrade, 0 to newly install, 0 to remove and 2 not to upgrade.

That's good. Nothing to do there. Now let's add Docker’s official GPG key:

nigel@ddev:~$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
OK

Now I need to verify that we have the key with the fingerprint 9DC8 5822 9FC7 DD38 854A E2D8 8D81 803C 0EBF CD88, by searching for the last 8 characters of the fingerprint.

nigel@ddev:~$ sudo apt-key fingerprint 0EBFCD88
pub   4096R/0EBFCD88 2017-02-22
      Key fingerprint = 9DC8 5822 9FC7 DD38 854A  E2D8 8D81 803C 0EBF CD88
uid                  Docker Release (CE deb) <docker@docker.com>
sub   4096R/F273FCD8 2017-02-22

All good. Next the following command to set up the stable repository.

nigel@ddev:~$ sudo add-apt-repository \
>    "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
>    $(lsb_release -cs) \
>    stable"

Update apt again

nigel@ddev:~$ sudo apt-get update
Hit:1 http://security.ubuntu.com/ubuntu xenial-security InRelease
Hit:2 http://gb.archive.ubuntu.com/ubuntu xenial InRelease
Hit:3 http://gb.archive.ubuntu.com/ubuntu xenial-updates InRelease
Hit:4 http://gb.archive.ubuntu.com/ubuntu xenial-backports InRelease
Get:5 https://download.docker.com/linux/ubuntu xenial InRelease [65.8 kB]
Get:6 https://download.docker.com/linux/ubuntu xenial/stable amd64 Packages [3,329 B]
Fetched 69.1 kB in 0s (140 kB/s)
Reading package lists... Done

Again we are looking good - we can see it's picked up the Docker repo ok. Let's install the latest version of Docker.

nigel@ddev:~$ sudo apt-get update

Let's check it's working..

nigel@ddev:~$ sudo docker run hello-world
[sudo] password for nigel: 
Unable to find image 'hello-world:latest' locally
latest: Pulling from library/hello-world
ca4f61b1923c: Pull complete 
Digest: sha256:083de497cff944f969d8499ab94f07134c50bcf5e6b9559b27182d3fa80ce3f7
Status: Downloaded newer image for hello-world:latest
 
Hello from Docker!
This message shows that your installation appears to be working correctly.

Success! Now we need docker-compose installing. Again, don't be tempted to install from the standard Ubuntu repos, because if you do with Ubuntu 16.04LTS you'll end up with docker-compose version 1.8.0 which does not meet the ddev requirements. So do it the proper way!

nigel@ddev:~$ sudo curl -L https://github.com/docker/compose/releases/download/1.19.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   617    0   617    0     0    795      0 --:--:-- --:--:-- --:--:--   795
100 8288k  100 8288k    0     0   355k      0  0:00:23  0:00:23 --:--:--  196k

Now make it executable

nigel@ddev:~$ sudo chmod +x /usr/local/bin/docker-compose

Let's see the version

nigel@ddev:~$ docker-compose --version
docker-compose version 1.19.0, build 9e633ef

Neat! We are almost there. Now we need to make sure Docker starts every time we boot the machine.

nigel@ddev:~/projects/meedjum$ sudo systemctl enable docker
Synchronizing state of docker.service with SysV init with /lib/systemd/systemd-sysv-install...
Executing /lib/systemd/systemd-sysv-install enable docker

Before I am done here, I need to add myself to the Docker group so I can execute Docker commands (or rather ddev can on my behalf)

nigel@ddev:~/projects/meedjum$ sudo usermod -aG docker $(whoami)

Rebooting will now serve two purposes - check that the above command works which will start Docker, and make sure my new group status has been picked up.

nigel@ddev:~/projects/meedjum$ sudo su
root@ddev:/home/nigel/projects/meedjum# init 6

Installing ddev

There are two ways of installing ddev - by downloading from the repository's releases - or use the install script in the ddev documentation. I opted for the latter.

nigel@ddev:~$ curl https://raw.githubusercontent.com/drud/ddev/master/install_ddev.sh | bash
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  2545  100  2545    0     0   5821      0 --:--:-- --:--:-- --:--:--  5823
ddev_linux.v0.15.0.tar.gz: OK
Download verified. Ready to place ddev in your /usr/local/bin.
Running "sudo mv /tmp/ddev /usr/local/bin/" Please enter your password if prompted.
[sudo] password for nigel: 
Bash completion for ddev was not installed. You may manually install /tmp/ddev_bash_completion.sh in your bash_completions.d directory.
ddev is now installed. Run "ddev" to verify your installation and see usage.

Installed - now check our installation

nigel@ddev:~$ ddev
This Command Line Interface (CLI) gives you the ability to interact with the ddev to create a development environment.
Usage:
ddev [command]
Available Commands:
auth-pantheon Provide a machine token for the global pantheon auth.
config Create or modify a ddev project configuration in the current directory
describe Get a detailed description of a running ddev project.
exec Execute a shell command in the container for a service. Uses the web service by default.
help Help about any command
hostname Manage your hostfile entries.
import-db Import the database of an existing project to the dev environment.
import-files Import the uploaded files directory of an existing project to the default public upload directory of your project.
list List projects
logs Get the logs from your running services.
pull Import files and database using a configured provider plugin.
remove Remove the development environment for a project.
restart Restart the development environment for a project.
ssh Starts a shell session in the container for a service. Uses web service by default.
start Start a ddev project.
stop Stop the development environment for a project.
version print ddev version and component versions
Flags:
-h, --help help for ddev
-j, --json-output If true, user-oriented output will be in JSON format.
Use "ddev [command] --help" for more information about a command.

We have it!

Getting Started with an Existing Drupal 8 Project

This blog has been built using Drupal 8 - so it made sense to use this for my first project. Let's create a directory for my projects and git clone. At this point I had already created a new .ssh key for my ddev VM and added it to my GitHub profile.

nigel@ddev:~$ mkdir projects
nigel@ddev:~$ cd projects/
nigel@ddev:~/projects$ git clone git@github.com:sanddevil/meedjum.git
Cloning into 'meedjum'...

Now let's cd into the project and config ddev for our Drupal 8 through its interactive shell.

nigel@ddev:~/projects/meedjum$ ddev config
Creating a new ddev project config in the current directory (/home/nigel/projects/meedjum) 
Once completed, your configuration will be written to /home/nigel/projects/meedjum/.ddev/config.yaml
 
Project name (meedjum): 
 
The docroot is the directory from which your site is served. This is a relative path from your project root (/home/nigel/projects/meedjum) 
You may leave this value blank if your site files are in the project root 
Docroot Location (docroot): 
Found a php codebase at /home/nigel/projects/meedjum/docroot. 
Project Type [php, drupal6, drupal7, drupal8, wordpress, typo3, backdrop] (php): drupal8
Configuration complete. You may now run 'ddev start'.

ddev is suggesting I should run start, so why not?

nigel@ddev:~/projects/meedjum$ ddev start
Network ddev_default created 
Starting environment for meedjum... 
ddev needs to add an entry to your hostfile.
It will require root privileges via the sudo command, so you may be required
to enter your password for sudo. ddev is about to issue the command: 
    sudo /usr/local/bin/ddev hostname meedjum.ddev.local 127.0.0.1 
Please enter your password if prompted. 
Running Command  Command=sudo /usr/local/bin/ddev hostname meedjum.ddev.local 127.0.0.1
[sudo] password for nigel: 
Pulling db (drud/mariadb-local:v0.8.0)... 
Creating ddev-meedjum-db ... done
Pulling dba (drud/phpmyadmin:v0.2.0)... 
Creating ddev-meedjum-web ... done
Creating ddev-meedjum-dba ...  
Creating ddev-meedjum-web ...  
 
Network ddev_default is external, skipping 
Pulling ddev-router (drud/ddev-router:v0.5.0)... 
Creating ddev-router ... done
 
Successfully started meedjum 
Your project can be reached at http://meedjum.ddev.local and https://meedjum.ddev.local

Installing Composer

Drupal 8 requires composer and that needs installing on our clean system. There are plenty of tutorials online on how to achieve this, so I'll whizz through this quickly.

nigel@ddev:~$ sudo apt-get update
Hit:1 http://security.ubuntu.com/ubuntu xenial-security InRelease
Hit:2 http://gb.archive.ubuntu.com/ubuntu xenial InRelease
Hit:3 http://gb.archive.ubuntu.com/ubuntu xenial-updates InRelease
Hit:4 http://gb.archive.ubuntu.com/ubuntu xenial-backports InRelease
Hit:5 https://download.docker.com/linux/ubuntu xenial InRelease
Reading package lists... Done

Install the dependencies

nigel@ddev:~$ sudo apt-get install curl php-cli php-mbstring git unzip
Reading package lists... Done

Download composer

nigel@ddev:~$ curl -sS https://getcomposer.org/installer -o composer-setup.php

Install it globally

nigel@ddev:~$ sudo php composer-setup.php --install-dir=/usr/local/bin --filename=composer
All settings correct for using Composer
Downloading...
 
Composer (version 1.6.3) successfully installed to: /usr/local/bin/composer
Use it: php /usr/local/bin/composer

Now check it's been installed correctly

nigel@ddev:~$ composer
   ______
  / ____/___  ____ ___  ____  ____  ________  _____
 / /   / __ \/ __ `__ \/ __ \/ __ \/ ___/ _ \/ ___/
/ /___/ /_/ / / / / / / /_/ / /_/ (__  )  __/ /
\____/\____/_/ /_/ /_/ .___/\____/____/\___/_/
                    /_/
Composer version 1.6.3 2018-01-31 16:28:17

Building Out the Drupal 8 Project

The ddev start command creates a new subdirectory called .ddev in the project's root directory. Within the directory we have config.yaml and docker-compose.yaml. The config file contains the configuration of our ddev project such as the version of PHP, webpage url, type of project (drupal8) amongst other items. The docker yaml file contains the container configuration.

Interaction with the ddev project can be accomplished in two ways, either with

ddev exec command

or by spawning a shell with

ddev ssh

and using exit to terminate the interactive session.

Our first requirement is to get dependencies into our D8 project since it is vendor-ised and uses composer as its dependency management.

Ok my Drupal core was on 8.4.4 and 8.4.5 and then 8.5 had been released so it needed updating, and in my case would update to 8.4.5 initially

nigel@ddev:~/projects/meedjum/docroot$ composer update --with-dependencies
Gathering patches for root package.
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 51 installs, 0 updates, 0 removals
Gathering patches for root package.
Gathering patches for dependencies. This might take a minute.

Now since there were schema changes, those need to be applied.

nigel@ddev:~/projects/meedjum/docroot$ ddev exec drush updatedb
Performing node_update_8401                                          [ok] 
Cache rebuild complete.                                              [ok] 
Finished performing updates.                                         [ok] 
The following updates are pending:
 
node module : 
  8401 -   Run a node access rebuild, if required. 
 
Do you wish to run all pending updates? (y/n): y

Settings.php

This is where things started to go awry. I already have a fully constructed settings.php and settings.local.php. The settings.php file contains my Memcached settings. However the memcache(d) PHP libraries aren't shipped in the ddev product. Obviously by that fact ddev doesn't support Memcached.

When I attempted a drush status command I was inundated with errors.

nigel@ddev:~/projects/meedjum/docroot/sites/default$ vi settings.local.php
nigel@ddev:~/projects/meedjum/docroot/sites/default$ ddev exec drush status
Drupal\memcache\MemcacheException: No Memcache extension found in /var/www/html/docroot/modules/contrib/memcache/src/DrupalMemcacheFactory.php on line 162 #0 /var/www/html/docroot/modules/contrib/memcache/src/DrupalMemcacheFactory.php(62): Drupal\memcache\DrupalMemcacheFactory->initialize()

As a consequence I commented out the Memcache settings

// Memcache
//Memcache configuration
//$settings['memcache']['servers'] = ['127.0.0.1:11211' => 'default'];
//$settings['memcache']['bins'] = ['default' => 'default'];
//$settings['memcache']['key_prefix'] = 'badzillad8';
//$settings['cache']['default'] = 'cache.backend.memcache';
?>

Importing the Database

The next problem is ddev looks for the db credentials in settings.php whereas I have my credentials in my settings.local.php file. I changed the credentials in the settings.local.php file and I copied my database file to the /tmp directory.

nigel@ddev:~/projects/meedjum/docroot/sites/default$ ddev import-db  --extract-path /tmp
Provide the path to the database you wish to import. 
Import path: /tmp/db-2018-03-10.sql.gz
Failed to import database for meedjum: failed to write settings file for meedjum: Failed to get Drupal settings file path: settings files already exist and are being managed by the user

More errors! The import failed. I thought it could be because it required the credentials in settings.php but that didn't work either. So I decided to use Drush instead:

nigel@ddev:~/projects/meedjum/docroot/sites/default$ ddev exec drush sql-cli < /tmp/db-2018-03-10.sql

HTTP Port Forwarding

Just like our earlier forwarding of the ssh port so we can log into the VM, we also have to forward http port 80 traffic. To do this, we go back to the virtual machine network configuration, and set up a redirect from port 9090 (somewhat arbitrary) on the host to port 80 on the guest. See the first screenshot. This will take us to the the default website on the VM. We need to explicitly tell a browser which site it is - to do that we add an entry on the machine where we will be using our browser - which in my case will be my MacBook.

So I have added the entry to /etc/hosts of the working ddev domain name and the localhost IP address

127.0.0.1       localhost
255.255.255.255 broadcasthost
::1             localhost
 
127.0.0.1 meedjum.ddev.local

Now we need to reboot our VM and then login back in and issue a ddev start on our project. We can also check whether everything is good with a docker ps command.

root@ddev:/home/nigel# init 6
Connection to 127.0.0.1 closed by remote host.
Connection to 127.0.0.1 closed.
Nigels-MacBook-Pro:tmp nigel$ ssh -p 2222 nigel@127.0.0.1
nigel@ddev:~$ cd projects/meedjum/
nigel@ddev:~/projects/meedjum$ ddev start
Starting environment for meedjum... 
nigel@ddev:~/projects/meedjum$ docker ps
CONTAINER ID        IMAGE                             COMMAND                  CREATED             STATUS                             PORTS                                                                                      NAMES
5fd9a60cb90c        drud/ddev-router:v0.5.0           "/app/docker-entrypo…"   10 seconds ago      Up 10 seconds (healthy)            0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp, 0.0.0.0:8025->8025/tcp, 0.0.0.0:8036->8036/tcp   ddev-router
cea77b7cbc6b        drud/nginx-php-fpm-local:v1.1.0   "/start.sh"              7 hours ago         Up 11 seconds (healthy)            443/tcp, 0.0.0.0:32771->80/tcp, 0.0.0.0:32770->8025/tcp                                    ddev-meedjum-web
2dc08e116820        drud/phpmyadmin:v0.2.0            "/run.sh phpmyadmin"     7 hours ago         Up 11 seconds (health: starting)   0.0.0.0:32769->80/tcp                                                                      ddev-meedjum-dba
f239a52ae806        drud/mariadb-local:v0.8.0         "/docker-entrypoint.…"   7 hours ago         Up 12 seconds (healthy)            0.0.0.0:32768->3306/tcp                                                                    ddev-meedjum-db

We can now point a web browser at the url we typed into our /etc/hosts file - see third image above. Ok - so we are close but not quite there yet! Looks like this could be the old trusted host pattern issue since it doesn't know about my domain meedjum.ddev.test.

Add ddev Domain to Trusted Hosts in Settings.php

...or rather in my case my settings.local.php file. I added the ddev domain name to the trusted hosts pattern array

$settings['trusted_host_patterns'] = [
  'meedjum.test',
  'meedjum.ddev.local',
];
?>

Copying the Assets

Adding the trusted host entry now means the web site loads successfully but of course the assets are missing and need copying down from my prod site. ddev provides a command for this:

nigel@ddev:~/projects/meedjum/docroot$ ddev import-files --src=/tmp/files.tar.gz
Successfully imported files for meedjum

100% my fault, but my file structure ended up as sites/default/files/files because I'd tarballed my prod files directory within the tarball, instead of just its contents. So I moved everything back one directory.

nigel@ddev:~/projects/meedjum/docroot$ mv sites/default/files/files/* sites/default/files/.
nigel@ddev:~/projects/meedjum/docroot$ mv sites/default/files/files/.htaccess sites/default/files/.
nigel@ddev:~/projects/meedjum/docroot$ rmdir sites/default/files/files

Completed Project

Ok so in the interim I fixed the missing Font Awesome library - not something I'd noticed before, but obviously it's been gitignored and it isn't in the composer.json file. Anyhoo the site is now fully functional and you can see from the URL bar I need to append the port :9090 as per my previous port forwarding fix.

Verdict

Playing with ddev was an interesting experience, not without challenges, but ultimately rewarding. Here are some of the points I made as I went along.

The ddev exec command is run as root. This is a problem because it basically means using composer with it - such as ddev exec composer update - would trash the file permissions of my codebase. Ownerships would become root, and that would lead to problems down the line. Composer should never be run as root. So the net effect is composer needs to be installed on the host system. Ideally I wanted a totally un-poluted filesystem without installing anything on the host beyond ddev. It also means since composer has a dependency on PHP, that needs to be installed, and now we have a system with different PHP CLI and FPM versions.
I couldn't get the ddev import-db command to work. A minor inconvenience and of course it is easy to use alternatives with the command line or drush.
Now I've got a working system - what next? I have a welter of phing targets to deploy my code, usually invoked by Jenkins. I could add phing at project level but how would I get Jenkins docker-ised up and running across all projects? I sense that could be tricky.
I can see ddev's value. I would place it in a small agency with both legacy D6 and D7 support projects alongside new D8 and WP builds. I can't see it as an enterprise solution - there is too much missing such as Memcache and the previously mentioned phing and Jenkins.

But all in all I really enjoyed my Saturday watching the football whilst playing with ddev and writing this blog - despite my teams losing!

blog terms

Drupal Drupal 8 Drupal 7 Drupal 6 devops Docker VirtualBox

Drupal 7 Feeds XPathParser RSS Import Screencast Tutorial

nigel — Sun, 08 May 2016 13:06:17 +0000

Drupal 7 Feeds XPathParser RSS Import Screencast Tutorial nigel Sun, 08/05/2016 - 14:06

Here's a screencast tutorial I have made for importing RSS feeds into Drupal 7 websites using the Feeds and Feeds XPathParser modules and fetching the data from Scalemates

Blog Widgets" aria-label="Embedded video for Drupal 7 Feeds XPathParser RSS Import Screencast Tutorial > Blog Widgets: https://www.youtube.com/embed/-_uSe0yi_6k?rel=0" frameborder="0" allowfullscreen="">

blog terms

YouTube Screencasts Drupal Drupal 7

Drupal Critical Update SA-CORE-2014-005 - How to Fix an Infected Site

nigel — Sun, 30 Nov 2014 11:16:19 +0000

Drupal Critical Update SA-CORE-2014-005 - How to Fix an Infected Site nigel Sun, 30/11/2014 - 11:16

The issuing of the security advisory SA-CORE-2014-005 - Drupal core - SQL injection on 15th October, and designated the status of Critical sent shock waves through the Drupal community. The inference being that unless the security fix was applied within seven hours of the advisory then a Drupal site owner should expect their site to be subjected to attack.

I look after many sites and quickly applied the fix to them. However I couldn't react within the seven hours - in fact I didn't even hear about the issue so quickly. Therefore it couldn't be considered a surprise when I discovered one of the sites I looked after had become infected.

The security advisory is suitably vague about the consequences of any attack and so I can only supply a fix for the problems I experienced on my site. Any other infected site may have different symptoms and consequences to mine obviously, and your mileage may vary.

The symptom I experienced was numerous email non delivery reports flooding my email client. All the original messages were emanating from my machine, and being created and issued through Apache Web Server meaning a script on one of my sites was generating the messages through an infected script. The subsequent attempt of external delivery was resulting the NDRs coming straight back to my email client.

To diagnose the issue, I spun up the email client mutt - which should be familiar with most dyed-in-the-wool Linux Engineers. Other clients will be able to provide the same information if you are not familiar or don't have mutt installed. You need to look at the header information to determine the provenance of the message so in mutt I hit return over one of the messages then hit 'h' for header information.

If you look carefully you will see under the header X-PHP_ORIGINATING-SCRIPT there is reference to db60.php and a particular line number. Bingo! We now know what generated the emails.

So to find the script simply issue a find command.

openSUSE-123-64-minimal:/srv/www/htdocs/tube # find . | grep db60.php
./modules/translation/db60.php
openSUSE-123-64-minimal:/srv/www/htdocs/tube # cd modules/translation
openSUSE-123-64-minimal:/srv/www/htdocs/tube/modules/translation # ls -las
total 88
 4 drwxrwxr-x  3 wwwrun www  4096 Nov 26 04:53 .
 4 drwxrwxr-x 42 wwwrun www  4096 Nov 19 20:24 ..
20 -rw-r--r--  1 wwwrun www 19175 Nov 19 20:24 db60.php
 4 drwxrwxr-x  2 wwwrun www  4096 Nov 19 20:24 tests
 4 -rw-rw-r--  1 wwwrun www   322 Nov 19 20:38 translation.info
24 -rw-rw-r--  1 wwwrun www 23389 Nov 19 20:24 translation.module
 4 -rw-rw-r--  1 wwwrun www  3278 Nov 19 20:24 translation.pages.inc
24 -rw-rw-r--  1 wwwrun www 22087 Nov 19 20:24 translation.test
openSUSE-123-64-minimal:/srv/www/htdocs/tube/modules/translation #

The file was copied to the /tmp directory and inspected. The file is obfuscated PHP and the eval command with the email generating payload is at the end.

Next step is to determine the IP address responsible for executing this script. This can be achieved by issuing the following:

openSUSE-123-64-minimal:/srv/www/htdocs/tube/modules/translation # grep db60.php /var/log/apache2/access_log | awk '{print $1}' | sort -n | uniq -c  | sort -n
      2 146.185.239.51

A whois search indicates this is a Russian address. Wherever it originates from, it needs to be blocked immediately. The best solution would be to block at it the firewall method. Since I wanted a solution then and there I blocked it first against the website by adding the address to the .htaccess file

openSUSE-123-64-minimal:/srv/www/htdocs/tube # tail -3 .htaccess
order allow,deny
deny from 146.185.239.51
allow from all

Now I wanted to determine how this mb60.php was being generated. I navigated to the document root of the website and the answer was apparent immediately. There should be no general.php in the root directory of a Drupal site.

openSUSE-123-64-minimal:/srv/www/htdocs/tube # ls -las *.php
 8 -rw-rw-r-- 1 wwwrun www  6604 Nov 19 20:24 authorize.php
 4 -rw-rw-r-- 1 wwwrun www   720 Nov 19 20:24 cron.php
24 -rw-rw-r-- 1 wwwrun www 23025 Dec 11  2013 general.php
 4 -rw-rw-r-- 1 wwwrun www   529 Nov 19 20:24 index.php
 4 -rw-rw-r-- 1 wwwrun www   703 Nov 19 20:24 install.php
20 -rw-rw-r-- 1 wwwrun www 19986 Nov 19 20:24 update.php
 4 -rw-rw-r-- 1 wwwrun www   417 Nov 19 20:24 xmlrpc.php

Yet more obfuscated PHP code which I immediately moved away from document root into the temporary directory.

I then decided to check the root directories of all my other Drupal 7 sites, and lo and behold I spied another rogue file, this time entitled css.php in one of them. I simple diff command proved it was a copy of the general.php file.

openSUSE-123-64-minimal:/srv/www/htdocs/sdsb # ls -las *.php
 8 -rw-r--r-- 1   6226 6226  6604 Nov 19 20:24 authorize.php
 4 -rw-r--r-- 1   6226 6226   720 Nov 19 20:24 cron.php
24 -rw-r--r-- 1 wwwrun www  23025 Apr 27  2014 css.php
 4 -rw-r--r-- 1   6226 6226   529 Nov 19 20:24 index.php
 4 -rw-r--r-- 1   6226 6226   703 Nov 19 20:24 install.php
20 -rw-r--r-- 1   6226 6226 19986 Nov 19 20:24 update.php
 4 -rw-r--r-- 1   6226 6226   417 Nov 19 20:24 xmlrpc.php
openSUSE-123-64-minimal:/srv/www/htdocs/sdsb # less css.php
openSUSE-123-64-minimal:/srv/www/htdocs/sdsb # diff css.php  /tmp/general.php

So the lesson is to check that your Drupal 7 installation has exactly the correct number and correctly named php scripts.
Next step is to remove all the messages in the mail queue waiting for delivery to be retried. I use exim for my MTA so my command is as follows:

openSUSE-123-64-minimal:~ # exim -bp
25m  1.1K 1XtXXl-0003eD-98 <wwwrun@calsync.co.uk>
          soulmusic11@aol.com
 
25m  1.1K 1XtXXm-0003f4-Fl <wwwrun@calsync.co.uk>
          soulmangtm@gmail.com
 
25m  1.0K 1XtXXn-0003fS-2n <wwwrun@calsync.co.uk>
          soulove@aol.com
 
25m  1.1K 1XtXXn-0003fZ-6J <wwwrun@calsync.co.uk>
          soulmover@gmail.com
 
25m  1.1K 1XtXXn-0003ft-Ma <wwwrun@calsync.co.uk>
          soulreaver234@gmail.com
 
25m  1.1K 1XtXXo-0003gB-5y <wwwrun@calsync.co.uk>
          soulmusic11@aol.com
 
25m  1.0K 1XtXXo-0003gG-Ay <wwwrun@calsync.co.uk>
          soulove@aol.com
 
25m  1.1K 1XtXXo-0003gL-Eh <wwwrun@calsync.co.uk>
          soulmusic11@aol.com
 
25m  1.1K 1XtXXo-0003gQ-Ip <wwwrun@calsync.co.uk>
          soulmover@gmail.com
 
25m  1.1K 1XtXXo-0003gi-US <wwwrun@calsync.co.uk>
          soulmangtm@gmail.com
 
25m  1.1K 1XtXXp-0003gn-1v <wwwrun@calsync.co.uk>
          soulrider777@gmail.com
 
25m  1.1K 1XtXXp-0003gt-6t <wwwrun@calsync.co.uk>                                                   
          soulmangtm@gmail.com                                                                      
 
openSUSE-123-64-minimal:~ #

To delete using exim use:

openSUSE-123-64-minimal:/srv/www/htdocs/tube # exim -bp | awk '/^ *[0-9]+[mhd]/{print "exim -Mrm " $3}' | bash
Message 1XtXXl-0003eD-98 has been removed
Message 1XtXXn-0003fZ-6J has been removed
Message 1XtXXn-0003ft-Ma has been removed
Message 1XtXXo-0003gB-5y has been removed
Message 1XtXXo-0003gG-Ay has been removed
Message 1XtXXo-0003gL-Eh has been removed
Message 1XtXXo-0003gQ-Ip has been removed
Message 1XtXXo-0003gi-US has been removed
Message 1XtXXp-0003gn-1v has been removed
Message 1XtXXp-0003gt-6t has been removed
openSUSE-123-64-minimal:/srv/www/htdocs/tube #

My final (and probably worthless) step was to create a cron job to automatically delete db60.php should it reappear, although I think I'll remove this entry in a couple of weeks since I believe the entire problem is now fixed.

openSUSE-123-64-minimal:/srv/www/htdocs # cd /var/spool/cron/tabs/
openSUSE-123-64-minimal:/var/spool/cron/tabs # tail -2 root
# Delete hacker script 
* * * * * rm /srv/www/htdocs/tube/modules/translation/db60.php > /dev/null 2>&1
openSUSE-123-64-minimal:/var/spool/cron/tabs #

blog terms

Drupal Drupal 7

tottenhamturfies.com: The Drupal game-changer

nigel — Thu, 08 Aug 2013 11:32:46 +0000

tottenhamturfies.com: The Drupal game-changer nigel Thu, 08/08/2013 - 12:32

Traditionally the open source Drupal CMS has been the mainstay of the corporate / NGO and charity market since it lends itself perfectly to the rapid development of websites in those sectors. It also has traction for social media sites, being possibly the best equipped CMS using contributed modules for that functionality; and in addition for news portals and blog networks too.

Today sees the launch of the Tottenham Hotspur http://www.tottenhamtufies.comgaming and gamification platform aimed at children aged between 7 and 10 years old. The site's underlying architecture is Drupal 7 which may not on initial consideration be the most obvious choice. The site operates in essence on a single url and presents overlays to the users to extend the experience and to play the games.

In fact Drupal met the requirements perfectly. Drupal out-of-the-box comes with multi-user, multi-role capability – an essential requirement for a site that needs different levels of membership for gated content, along with back-end administration to create the content. Drupal's built-in concept of content types is ideal for these administrators to create the competitions, quizzes, quick polls and football predictions for the children, administered using a dashboard created with the Panels module.

Connectivity to external API web services is easily constructed with supporting helper modules and configuration credentials can be set by extending the superadmin menu scheme making the flip between sandbox and production services a breeze.

The Drupal database schema is extensible and this is the bedrock of the gamification logic. The gamification needed to cater for leaderboards, experience points, coins, medals (default blue and also a hierarchy of bronze, silver, gold), trophies, levelling up and asset unlocks upon achievement. The site also introduces the concept of 'promocodes' – unique alpha-numeric combinations of the format A2B-C3D-EF4 (with O0LI1 removed from the set of valid characters / numbers to avoid confusing the children) which can be used in an offline or online context to redeem against points, coins, trophies and medals. So, a child awarded a unique promocode for being a ball-boy at a game at White Hart Lane can type in the code on the site and have a trophy added to his trophy cabinet. The entire gamification business logic was complex but using object oriented PHP (PHP being Drupal's native language) reduced the chore of the activity.

Drupal's session management enables logged in users to have their progress restored automatically when re-opening a browser. Its internal API allowed the construction of the Ajax front-end back-end handshaking mechanism so for instance a call from the front-end to the back-end to delete a user's email will trigger a whole sequence of events including gamification checks (has the user been awarded points for keeping their inbox tidy? And as a consequence of that have they won a medal or levelled up?) and subsequence database updates that would be reflected and reported back to the front-end.

Throughout the lifespan of the project I was adamant that, whist Drupal was a somewhat unconventional choice in the first instance, it has proven itself and my belief that choice was correct has never wavered. Hopefully other industry professionals will have the courage to select Drupal as their choice of architecture for their avant-garde project too!

Badzilla is Hangar Seven's Consultant Technical Director

blog terms

Drupal Drupal 7

Drupal 7 - Setting Up Piecemaker 3D Slider with InnoCompany Theme

nigel — Sat, 08 Jun 2013 11:49:22 +0000

Drupal 7 - Setting Up Piecemaker 3D Slider with InnoCompany Theme nigel Sat, 08/06/2013 - 12:49

Subsequent to my earlier blog on installing and setting up the commercial InnoCompany Drupal 7 theme, it is now time to do something useful - set up the Piecemaker 3D slider which is based on Flash animation, with an XML configuration file. Thankfully a lot of the work has already been bundled into the InnoCompany theme and there isn't that much to do. Principally the slider images, captions and links are included in theme configuration, and there are 10 available placeholders which means the carousel may have up to 10 images. Once this has been saved as theme settings it is retrieved in template.php->icomp_get_slider_html()->icomp_prepare_piecemaker() and the XML file is written out for the Flash file to process.

Go to admin/appearance/settings/icompany and scroll down to the Slider setting. Change the selection to Piecemaker Slider

Click on the next tab down and start populating each image in the carousel. Note well that you need to make your images 1050px by 400px and not the 1170x450px as prompted. The dimensions suggested are for the other slider types included in the theme that span the entire web page width. Piecemaker 3D needs to sit inside its own div containers. Furthermore, the ratios are slightly different as I discovered to my cost. Now the fields - I copied my images to a directory below the standard image area - /sites/default/images/slider. The target link for the image should be a valid landing page, and ideally pertinent to the image you are showing. In my case, it's the portfolio narrative item for the experience the image is showing.

If you now save your carousel settings then navigate to your homepage (remember to flush your browser's cache also) you should see your completed slider. However, there is a bug we still need to deal with...

Clicking on Info shows the heading and caption associated with the image. However, there is a bug in the previously mentioned template.php file - when it writes out the XML file it uses the H2 tag for the heading text and not H1. This can be fixed by either editing the template file or the css file. I elected to edit the css file...

Change the /sites/all/themes/icompany/sliders/piecemaker/piecemaker.css file

/* CSS Document */
 
H2 {
        font-family: Verdana;
        font-style: bold;
        font-weight: normal;
        color: #222222;
        display: block;
        font-size: 20px;
        margin-bottom: 10px;
        line-height: 30;
        text-align: left;
        letter-spacing: 0px;
}

Note how I've changed the H1 to H2 so the XML finds the correct tag. You can take this opportunity to edit the tag to how you want it output in the info box. That's all there is to it :)

blog terms

Drupal Drupal 7

Drupal 7 - Installing and Setting Up the Commercial InnoCompany Theme

nigel — Sun, 02 Jun 2013 12:58:00 +0000

Drupal 7 - Installing and Setting Up the Commercial InnoCompany Theme nigel Sun, 02/06/2013 - 13:58

This is a tutorial for installing and setting up the commercial InnoCompany Theme that retails for around $45 in the US (£32 or so in the UK). The theme offers a multi-purpose corporate solution, but my own use is to create a portfolio site. I consider myself a back-end Drupal dev first and foremost, and my feeling is it would take me too long to create a neat portfolio site (which must of course be Drupal) from scratch. That effort would detract from my paid work for my clients and the pro bono weekend work I undertake for charities.

Despite the theme being constructed by WorthAPost, payment is I actually made to themeforest. Once the theme is bought it can be downloaded as a zip file.

To follow this tutorial, the following assumptions are made:

You have already set up a LAMP stack on your rig with a working Apache server and PHP and MySQL
You have Drush installed
You have an understanding of Linux command line
You have at least a passing knowledge of Drupal 7

Ok, so firstly navigate to the innocompany download which under most circumstances will by either in your home downloads directory, or in my case /tmp.

badzilla@linux-ldan:~> cd /tmp
badzilla@linux-ldan:/tmp> ls -las *.zip
29452 -rw-r--r-- 1 badzilla users 30158778 May 31 21:40 themeforest-3177223-innocompany-multipurpose-corporate-drupal-theme.zip
badzilla@linux-ldan:/tmp>

The zip file expands into the current directory (nasty and messy) so create a subdirectory and move the zip file into it, then unzip

badzilla@linux-ldan:/tmp> mkdir innocompany
badzilla@linux-ldan:/tmp> cd innocompany/
badzilla@linux-ldan:/tmp/innocompany> cp ../themeforest-* .
badzilla@linux-ldan:/tmp/innocompany> unzip themeforest-*

The zip file expands to quite a complicated file structure. It ships with features and views to minimise the effort of setting up the theme since these are dependencies. The entire directory tree is shown below.

badzilla@linux-ldan:/tmp/innocompany> find ./ -type d | sed -e 's/[^-][^\/]*\//--/g;s/--/ |-/'
 |-
 |-theme_with_demo_installation
 |---compressed_database
 |-standalone_theme
 |---icompany
 |-----forum
 |-----js
 |-----sliders
 |-------iview
 |---------js
 |---------img
 |---------css
 |-----------skin1
 |-----------skin4
 |-------piecemaker
 |---------scripts
 |-----------swfobject
 |-------flex
 |---------images
 |-------nivo
 |---------themes
 |-----------bar
 |---------images
 |-------elastic
 |---------js
 |---------css
 |---------images
 |-----simplenews
 |-----img
 |-------slides
 |-------icons
 |---------48
 |---------picons
 |-------bg
 |-----views
 |-----css
 |-------images
 |---------ie6
 |-----cache
 |-----fonts
 |-----includes
 |-licensing
 |-Documentation
 |---img
 |---bootstrap
 |-----js
 |-----img
 |-----css
 |-psd
 |-modules
 |---features
 |-----tests
 |-----includes
 |-----theme
 |---jquery_update
 |-----replace
 |-------ui
 |---------ui
 |-----------minified
 |-------------i18n
 |-----------i18n
 |---------themes
 |-----------base
 |-------------minified
 |---------------images
 |-------------images
 |---------external
 |-------jquery
 |---------1.5
 |---------1.7
 |---------1.8
 |-------misc
 |---------1.7
 |---token
 |-----tests
 |---icompany_config
 |---views
 |-----views_export
 |-----tests
 |-------test_plugins
 |-------taxonomy
 |-------user
 |-------node
 |-------plugins
 |-------templates
 |-------styles
 |-------field
 |-------handlers
 |-------comment
 |-----js
 |-----plugins
 |-------export_ui
 |-------views_wizard
 |-----css
 |-------ie
 |-----help
 |-------images
 |-----handlers
 |-----includes
 |-----drush
 |-----modules
 |-------translation
 |-------taxonomy
 |-------user
 |-------filter
 |-------node
 |-------locale
 |-------aggregator
 |-------search
 |-------system
 |-------profile
 |-------tracker
 |-------field
 |-------statistics
 |-------book
 |-------contact
 |-------comment
 |-----theme
 |-----images
 |---icompany_module
 |-----.settings
 |---ctools
 |-----page_manager
 |-------js
 |-------plugins
 |---------task_handlers
 |---------tasks
 |---------cache
 |-------css
 |-------help
 |-------theme
 |-------images
 |-----ctools_ajax_sample
 |-------js
 |-------css
 |-------images
 |-----tests
 |-------ctools_export_test
 |-------plugins
 |---------not_cached
 |---------cached
 |-----bulk_export
 |-----js
 |-----ctools_plugin_example
 |-------plugins
 |---------content_types
 |---------access
 |---------relationships
 |---------arguments
 |---------contexts
 |-------help
 |-----stylizer
 |-------plugins
 |---------export_ui
 |-----plugins
 |-------content_types
 |---------entity_context
 |---------term_context
 |---------block
 |---------node_form
 |---------node_context
 |---------token
 |---------page
 |---------custom
 |---------node
 |---------search
 |---------form
 |---------user_context
 |---------vocabulary_context
 |---------contact
 |---------comment
 |-------access
 |-------relationships
 |-------export_ui
 |-------arguments
 |-------cache
 |-------contexts
 |-----ctools_custom_content
 |-------plugins
 |---------export_ui
 |-----views_content
 |-------plugins
 |---------content_types
 |---------views
 |---------relationships
 |---------contexts
 |-----css
 |-----ctools_access_ruleset
 |-------plugins
 |---------access
 |---------export_ui
 |-----help
 |-----includes
 |-----drush
 |-----images
 |---jcarousel
 |-----js
 |-----skins
 |-------default
 |-------tango
 |-----includes

Next you will need to create a MySQL database for your site. I tend to do this on the command line - a habit I've got into.

badzilla@linux-ldan:/tmp/innocompany> mysql -u root
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 181
Server version: 5.5.28-log Source distribution
 
Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.
 
Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.
 
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
 
mysql> CREATE DATABASE portfolio;
database created
mysql> GRANT ALL PRIVILEGES ON portfolio.* TO 'database_username'@'localhost' WITH GRANT OPTION;
Query OK, 0 rows affected (0.77 sec)
mysql> quit
Bye

You will need to change database_username to whatever value you are using. Next we need to create the document root for the website - and this is where the convention varies between Linux distros. Since I'm using openSUSE I placed my website under /srv/www/htdocs/ but I know other distros such as the immensely popular Ubuntu uses /var/www/html/. Pick whichever is appropriate for your rig. Whichever you choose, ensure that:

Apache user and group has write access to the document root
The user you use at the command line is a member of the Apache group and the directory has group write permissions

badzilla@linux-ldan:/tmp/innocompany> cd /srv/www/htdocs
badzilla@linux-ldan:/srv/www/htdocs> drush dl drupal
Project drupal (7.22) downloaded to /srv/www/htdocs/drupal-7.22.                                                 [success]
Project drupal contains:                                                                                         [success]
 - 3 profiles: minimal, testing, standard
 - 4 themes: seven, garland, bartik, stark
 - 47 modules: comment, syslog, menu, shortcut, simpletest, contact, trigger, book, statistics, field_ui, update,
dblog, contextual, list, options, field_sql_storage, text, number, field, openid, path, image, tracker, help,
profile, system, search, aggregator, rdf, locale, node, filter, poll, dashboard, color, block, blog, user,
overlay, taxonomy, forum, translation, file, php, toolbar, drupal_system_listing_compatible_test,
drupal_system_listing_incompatible_test
 
badzilla@linux-ldan:/srv/www/htdocs> mv drupal-7.22 portfolio
badzilla@linux-ldan:/srv/www/htdocs>

Note how I use drush to download the latest version of Drupal and then since it creates the directory under the name of the latest version of Drupal, I rename it to portfolio since that's what I want my document root to be called. You can now install the Drupal download, and this can be effected by using Drush. Change directory to inside portfolio and execute the following command below. It is unimportant what you specify for the Drupal user 1 values since they will be overwritten shortly when we create the InnoCompany demo data. However, you will need to change your database username, password and db name. Also I've had problems in the past with Drupal understanding localhost so I always use 127.0.0.1 instead.

badzilla@linux-ldan:/srv/www/htdocs> cd portfolio
badzilla@linux-ldan:/srv/www/htdocs/portfolio> drush site-install standard --account-name=admin --account-pass=admin --db-url=mysql://your_username:your_password@127.0.0.1/your_db_name
You are about to create a sites/default/files directory and create a sites/default/settings.php file and DROP all tables in your 'portfolio' database. Do you want to continue? (y/n): y
Starting Drupal installation. This takes a few seconds ...                                                       [ok]
Installation complete.  User name: admin  User password: admin                                                   [ok]
badzilla@linux-ldan:/srv/www/htdocs/portfolio>

Now it's almost time to check you have a functioning website - but that will need a change to the Apache configuration first. Here your mileage will vary dependent upon your setup. I am adding to the httpd.conf file (not necessarily a good idea since changes could be lost in a system upgrade), and your configuration could be different. /etc/apache2/httpd.conf

<VirtualHost *:80>
	DocumentRoot "/srv/www/htdocs/portfolio"
	ServerName portfolio.localhost
        ServerAlias portfolio.localhost
	RewriteEngine On
	RewriteOptions Inherit
VirtualHost>
 
<Directory /srv/www/htdocs/portfolio>
	Options -Indexes +FollowSymLinks
	AllowOverride All
	Order allow,deny
	Allow from all
directory>

Next an entry to the hosts file is required to ensure you can actually point a browser at your site. /etc/hosts

127.0.0.1	portfolio.localhost

Now it's time for an Apache reboot

badzilla@linux-ldan:/srv/www/htdocs/portfolio> sudo /etc/init.d/apache2 restart
redirecting to systemctl
badzilla@linux-ldan:/srv/www/htdocs/portfolio>

By pointing a browser to portfolio.localhost you should be able to see the website, albeit without (as yet) the InnoCompany theme and functionality

I noticed that the Webform module is not listed in the directory tree above, yet the site does use it for the contact form. So this needs to be added.

badzilla@linux-ldan:/srv/www/htdocs/portfolio> drush dl webform
Project webform (7.x-3.19) downloaded to /srv/www/htdocs/portfolio/sites/all/modules/webform.                    [success]
badzilla@linux-ldan:/srv/www/htdocs/portfolio> drush en webform -y
The following extensions will be enabled: webform
Do you really want to continue? (y/n): y
webform was enabled successfully.                                                                                [ok]
badzilla@linux-ldan:/srv/www/htdocs/portfolio>

Now let's copy over the modules from the InnoCompany directory tree.

badzilla@linux-ldan:/srv/www/htdocs/portfolio> cd sites/all/modules/
badzilla@linux-ldan:/srv/www/htdocs/portfolio/sites/all/modules> ls
README.txt  webform
badzilla@linux-ldan:/srv/www/htdocs/portfolio/sites/all/modules> cp -R /tmp/innocompany/modules/* .
badzilla@linux-ldan:/srv/www/htdocs/portfolio/sites/all/modules> ls
ctools  features  icompany_config  icompany_module  jcarousel  jquery_update  README.txt  token  views  webform
badzilla@linux-ldan:/srv/www/htdocs/portfolio/sites/all/modules>

The theme is situated in the standalone_theme directory in the tree, in a zip file. So unzip this into sites/all/themes as per the Drupal convention.

badzilla@linux-ldan:/srv/www/htdocs/portfolio/sites/all/modules/icompany_config> cd ../../themes/
badzilla@linux-ldan:/srv/www/htdocs/portfolio/sites/all/themes> unzip /tmp/innocompany/standalone_theme/icompany.zip
Archive:  /tmp/innocompany/standalone_theme/icompany.zip
   creating: icompany/
  inflating: icompany/block--footer1.tpl.php  
  inflating: icompany/block--footer2.tpl.php  
etc.....

In the Documentation directory in the tree there is a file called docs.html that unsurprisingly contains useful configuration information. So copy this to the document root along with its supporting img directory files BUT REMEMBER TO DELETE THIS FILE BEFORE HOSTING YOUR WEBSITE!!

badzilla@linux-ldan:/srv/www/htdocs/portfolio/sites/all/themes> cd ../../..
badzilla@linux-ldan:/srv/www/htdocs/portfolio> cp /tmp/innocompany/Documentation/docs.html .
badzilla@linux-ldan:/srv/www/htdocs/portfolio> cp -R /tmp/innocompany/Documentation/img .

Ok so now we need to add the sql statements provided by WorthAPost - this will provide all the startup data to pre-populate our Drupal database. I've elected for the strategy of using the test data and amending to fit my circumstances rather than building from scratch. The test data db commands can be found in the directory tree at theme_with_demo_installation in a zipped file with a filename commencing InnoCompany-

badzilla@linux-ldan:/tmp/innocompany/theme_with_demo_installation/compressed_database> ls -lash
total 160K
4.0K drwxr-xr-x 2 badzilla users 4.0K Apr 20 23:16 .
4.0K drwxr-xr-x 3 badzilla users 4.0K Apr 20 23:19 ..
152K -rw-r--r-- 1 badzilla users 152K Apr 20 23:16 InnoCompany-2013-04-20T23-16-41.mysql.gz
badzilla@linux-ldan:/tmp/innocompany/theme_with_demo_installation/compressed_database> gunzip InnoCompany-2013-04-20T23-16-41.mysql.gz
badzilla@linux-ldan:/tmp/innocompany/theme_with_demo_installation/compressed_database> mysql -u your_db_username -p portfolio
Enter password: 
Reading table information for completion of table and column names
You can turn off this feature to get a quicker startup with -A
 
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 193
Server version: 5.5.28-log Source distribution
 
Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.
 
Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.
 
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
 
mysql> source InnoCompany-2013-04-20T23-16-41.mysql;
...etc...
Query OK, 0 rows affected (0.00 sec)
 
Query OK, 0 rows affected (0.00 sec)
 
Query OK, 0 rows affected (0.00 sec)
 
Query OK, 0 rows affected (0.00 sec)
 
Query OK, 0 rows affected (0.00 sec)
 
mysql>

There are a number of test images which belong in sites/default/files. These are buried quite deep in the InnoCompany filesystem and first need expanding out of an entire Drupal build and then copying to the correct place.

badzilla@linux-ldan:/srv/www/htdocs/portfolio> cd /tmp/innocompany/theme_with_demo_installation/
badzilla@linux-ldan:/tmp/innocompany/theme_with_demo_installation> unzip themeforest-3177223-innocompany-multipurpose-corporate-drupal-theme.zip
badzilla@linux-ldan:/srv/www/htdocs/portfolio> cp -R /tmp/innocompany/theme_with_demo_installation/sites/default/files/* sites/default/files/.
badzilla@linux-ldan:/srv/www/htdocs/portfolio>

Now refresh your browser and you will see the site appear, albeit the site in maintenance mode screen.

Navigate to /user and login with the credentials of Username: worthapost and password of worthapost. Once you are in, immediately change the username and the password by clicking on your username (top right) and then the Edit tab. You will also probably want to change the timezone setting at the same time.

Take a look at /docs.html and you'll see the config page that came with the installation.

It is now worthwhile to perform some tidy-up activities, such as ensure that the permissions are set correctly on the filesystem, and update.php has been run.

badzilla@linux-ldan:/srv/www/htdocs/portfolio> sudo chown -R wwwrun:www *
root's password:
badzilla@linux-ldan:/srv/www/htdocs/portfolio> sudo chown -R wwwrun:www .*
badzilla@linux-ldan:/srv/www/htdocs/portfolio> sudo chmod -R ag+w *
badzilla@linux-ldan:/srv/www/htdocs/portfolio> drush updatedb
Operations on Unicode strings are emulated on a best-effort basis. Install the PHP mbstring extension for        [warning]
improved Unicode support. (Currently using Unicode library Standard PHP)
The following updates are pending:
 
webform module : 
  7321 -   Remove files left over from deleted submissions. Such files are now deleted  automatically. 
 
Do you wish to run all pending updates? (y/n): y
Operations on Unicode strings are emulated on a best-effort basis. Install the PHP mbstring extension for        [warning]
improved Unicode support. (Currently using Unicode library Standard PHP)
Performed update: webform_update_7321                                                                            [ok]
Finished performing updates.                                                                                     [ok]
badzilla@linux-ldan:/srv/www/htdocs/portfolio>

You should now have a fully functioning website. There is now plenty to do since you need to replace all the test data with your own, and your basic site details (such as name, email address etc) should be set by going to admin/config/system/site-information. All these activities can be worked on in the fullness of time, and I will be providing more tutorials to aid that process as I build my own portfolio site.

blog terms

Drupal Drupal 7

Drupal 7 - User Restrictions Batch Module

nigel — Mon, 04 Mar 2013 15:25:18 +0000

Drupal 7 - User Restrictions Batch Module nigel Mon, 04/03/2013 - 15:25

This module extends the existing user_restrictions module by providing a mechanism for the bulk import of prohibited words in the screen name during user registration. This is useful to ensure that on a community site no users attempt to create accounts with offensive names. Without this module, any admin wishing to add a few hundred words to the user_restrictions list would face quite an onerous chore to type them all in. With the module, they can be cut and pasted from an existing source into a textarea in one go. The textarea allows for carriage return / linefeeds and will also remove commas between words. The module was very easy to put together, so I don't believe there is anything requiring further expansion. If you disagree, drop me a line and I'll answer your questions. :) user_resitrictions_batch.module

/*
 * File         : user_restrictions_batch.module
 * Title        : Batch add of user restrictions
 * Sponsor      : Hangar Seven Digital
 * Author       : Badzilla www.badzilla.co.uk @badzillacouk
 *
 * This work is copyright Badzilla under the GPL licence terms and conditions
 *
 */

/**
 * Implements hook_menu().
 */
function user_restrictions_batch_menu() {

    $edit_restrictions = array('edit user restriction rules');
    $items = array();

    $items['admin/config/people/user-restrictions/batch-input'] = array(
            'title' => 'Batch input ',
            'page callback' => 'drupal_get_form',
            'page arguments' => array('user_restrictions_batch_input_form', 4),
            'access arguments' => $edit_restrictions,
            'type' => MENU_LOCAL_ACTION,
    );

    return $items;
}

function user_restrictions_batch_input_form($form, &$form_state) {

    $form = array();

    $form['banned'] = array(
        '#type' => 'textarea',
        '#title' => t('Enter prohibited words'),
        '#required' => TRUE,
        '#weight' => 0
    );
    
    $form['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Save rule'),
    );

    return $form;    
}

function user_restrictions_batch_input_form_submit($form, &$form_state) {

    $lines = explode("\r\n", $form_state['values']['banned']);
    if (count($lines)) 
        foreach($lines as $line) {
            $phrases = explode(",", $line);

            if (count($phrases))
                foreach($phrases as $phrase)
                    if ($phrase = trim($phrase))
                        db_insert('user_restrictions')
                            ->fields(array('urid' => NULL, 'mask' => $phrase, 'type' => 'name', 'subtype' => '', 'status' => 0, 'expire' => 0))
                            ->execute();
        }    
}
?>

user_resitrictions_batch.info

name = User restrictions_batch
description = Brute force batch insertion of restricted words.
core = 7.x
project = "user_restrictions"

blog terms

Drupal Drupal 7 PHP

Drupal 7 - Node Limit Publish Module

nigel — Fri, 04 Jan 2013 15:29:28 +0000

Drupal 7 - Node Limit Publish Module nigel Fri, 04/01/2013 - 15:29

This module adds a configurable limit to how many nodes of any content type can be published at any one time. This is useful in circumstances such as when a website has created content types of polls or competitions or quizzes but only one of each type can be live and published at any one time. Of course the module allows limits other than 1 in case there is such a circumstance. The default is 0 which means unlimited. A web author may create content and exceed the limits providing the content remains unpublished. This allows for content to be created in advance of publication.

If a web author attempts to publish some content which would exceed the limit, the content is saved as unpublished.

The admin should go to admin/config/content/node_limit_publish to set the limits for each content type known to the system.

node_limit_publish.info

name = Node Limit Publish
description = Limit the number of published nodes per type
core = 7.x
configure = admin/config/content/node_limit_publish

node_limit_publish.module

/*
 * File         : node_limit_publish.module
 * Title        : Limits the number of concurrently published node types dependent upon admin configurable limits
 * Sponsor      : Hangar Seven Digital
 * Author       : Badzilla www.badzilla.co.uk @badzillacouk
 *
 * This work is copyright Badzilla under the GPL licence terms and conditions
 *
 */

/**
* Implementation of hook_menu().
*
*/
function node_limit_publish_menu() {
    
    $items = array();

    $items['admin/config/content/node_limit_publish'] = array(
        'title' => 'Limit Number of Published Nodes per Node Type',
        'description' => t('Zero represents an unlimited amount of published nodes'),
        'page callback' => 'drupal_get_form',
        'page arguments' => array('node_limit_publish_admin_settings'),
        'access arguments' => array('administer node_limit_publish'),
        'type' => MENU_NORMAL_ITEM,
    );
    
    return $items;
}


function node_limit_publish_admin_settings() {
    
    $form = array();

    if (is_array($types = node_type_get_types())) {

        $form['title'] = array(
            '#markup' => t('Zero represents an unlimited amount of published nodes'),
        );

        foreach($types as $key => $value) 
            $form['node_limit_publish_'.$key] = array(
                '#type' => 'textfield',
                '#description' => $key,
                '#size' => 4,
                '#maxlength' => 10,
                '#element_validate' => array('node_limit_publish_is_numeric'),
                '#default_value' => variable_get('node_limit_publish_'.$key, 0),                
            );
    }

    return system_settings_form($form);
}


function node_limit_publish_is_numeric($element, &$form_state, $form) {
    
    if (!is_numeric($element['#value']))
        form_error($element, t('This field must be numeric'));
}


/**
* Implementation of hook_presave().
*
*/
function node_limit_publish_node_presave($node) {
    
    // Get the limit on this type
    if (($limit = variable_get('node_limit_publish_'.$node->type, 0)) and $node->status == 1) {
        // now check whether we have reached our maximum
        $query = db_select('node')
            ->condition('type', $node->type)
            ->condition('status', 1);
        if (isset($node->nid))
            $query->condition('nid', $node->nid, '!=');
        $count = $query->countQuery()
            ->execute()
            ->fetchField();

        if ($count >= $limit) {
            $node->status = 0;
            drupal_set_message(t('Sorry, the maximum amount of published content for %type has already been reached.', array('%type' => $node->type)), 'warning');
        }
    }
}
?>

blog terms

Drupal Drupal 7

Drupal 7 - Form in a Block With Template File

nigel — Wed, 24 Oct 2012 15:55:22 +0000

Drupal 7 - Form in a Block With Template File nigel Wed, 24/10/2012 - 16:55

I have been coming up against the same Drupal 7 requirement over and over recently - the need to have a form in a block with a separate template file I can pass over to the front-end guy to weave his magic. This is one of my easiest ever tutorials, and is really only here as an aide memoire for when I can't quite remember the exact syntax in say hook_theme or I can't remember which rendering functions I call in the template.

By using the module below, you have an excellent boilerplate to start your FAPI coding since this pattern repeats (as I have noted) over and over! Too easy!

fb_pattern.info

name = Form / Block Pattern
description = Boilerplate form in a block pattern code with template file
core = 7.x

fb_pattern.module

/*
 * File         : fb_pattern.module
 * Title        : Drupal 7 Boilerplate form in a block pattern with template file
 * Author       : www.badzilla.co.uk @badzillacouk
 *
 * This work is copyright BadZilla under the GPL licence terms and conditions
 *
 */


/*
 * Implements fb_pattern_info
 */
function fb_pattern_block_info() {
    
    $block = array();

    // Sign up block
    $block['fb_pattern'] = array(
                'info' =>   t('Form / Block Pattern Example'),
                'weight' => 0);  

    return $block;
}



/*
 * Implements hook_block_view
 */
function fb_pattern_block_view($delta) {
    
    $block = array();

    switch($delta) {
        case 'fb_pattern':
            $block['title'] = t('Sample Form in a Block Pattern');
            $block['content'] = drupal_get_form('fb_pattern_form'); 
            break;
    }

    return $block;
}




function fb_pattern_form($form, &$form_state) {
    
    $form['age'] = array(
        '#title' => t('Age'),
        '#type' => 'textfield',
        '#required' => TRUE,
        '#maxlength' => 3,
        '#size' => 3,
        '#weight' => 0,
    );

    $form['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Submit'),
        '#weight' => 10,
        '#validate' => array('fb_pattern_form_validate'),
        '#submit' => array('fb_pattern_form_submit'),
    );

    $form['#theme'][] = 'fb_pattern_form';
   
    return $form;
}



function fb_pattern_form_validate($form, &$form_state) {
    
    if (!is_numeric($form_state['values']['age']))
        form_set_error('age', t('That doesn\'t look like a valid age to me!'));

}



function fb_pattern_form_submit($form, &$form_state) {
    
    drupal_set_message(t('Wow! You don\'t look :age - have you had work done?', array(':age' => $form_state['values']['age']))); 
}



/*
 * Implements hook_theme
 */
function fb_pattern_theme() {
    
    return array(
        'fb_pattern_form' => array(
            'arguments' => array('form' => NULL),
            'render element' => 'form',
            'template' => 'fb_pattern_form',
        ),
    );
}
?>

fb_pattern_form.tpl.php

/*
 * File         : fb_pattern_form.tpl.php
 * Title        : Drupal 7 Boilerplate form in a block pattern with template file
 * Author       : www.badzilla.co.uk @badzillacouk
 *
 * This work is copyright BadZilla under the GPL licence terms and conditions
 *
 */


?>
        

    print render($form['age']); ?>


    print render($form['submit']); ?>


    print drupal_render_children($form); ?>

blog terms

Drupal Drupal 7