Drupal 6

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

How to use Drupal 6 bookcat module with FNProgramvare BookCAT 10

nigel — Sun, 03 Feb 2013 09:50:55 +0000

How to use Drupal 6 bookcat module with FNProgramvare BookCAT 10 nigel Sun, 03/02/2013 - 09:50

When I originally developed my Drupal 6 bookcat module as a CMS website version of FNProgramvare's BookCAT product, it was aimed at BookCAT version 8. Since then Fredrik's BookCAT has gone through two further revisions, and during that process the database schema has changed. This has led to problems with my Drupal 6 module and as a consequence I've introduced a solution which circumvents the necessity to redevelop my work or have multiple versions of my own.

To get FNProgramvare's BookCAT database into the Drupal CMS, you need to use the Bullzip MS Access-> MySQL conversion facility. This will give you an MySQL sql dump file comprising many thousands of MMySQL commands. To ensure the continued use of my Drupal module, before importing the dump file into MySQL, simply add the following lines to the end of the code.

UPDATE `BookImage` SET `Image` = NULL WHERE `Image` = 'TPF0' AND `ImageExternal` = 1;
UPDATE `PersonImage` SET `Image` = NULL WHERE `Image` = 'TPF0' AND `ImageExternal` = 1;
ALTER TABLE `Book` CHANGE `TitleSort` `SortBy` varchar(255);
ALTER TABLE `Contents` CHANGE `TitleSort` `SortBy` varchar(255);

This will amend your database schema so it will now work with my Drupal 6 bookcat module :)

blog terms

Drupal Drupal 6 MySQL

Drupal 6: Set Default Value in CCK Select List Widget Using PHP

nigel — Sun, 15 Jul 2012 16:33:44 +0000

Drupal 6: Set Default Value in CCK Select List Widget Using PHP nigel Sun, 15/07/2012 - 17:33

When a select list widget is created in a field using CCK in Drupal 6, it is possible to manually set a default value as one of the form fields (see below). However, it may not always be preferable to do this, and on occasion there may be a desire to achieve this dynamically with some PHP code. A good example of such circumstances would be a country select field which defaults to the country the user is viewing the website from - this itself could be discovered using an IP address look-up.

So how do we do this? There are two different ways of applying the PHP code - firstly, as a PHP snippet in the CCK field itself providing you have PHP snippets enabled in admin/build/modules - this can be seen below. The second method would be in a custom module using the hook hook_form_alter.

The PHP Snippet method is a little esoteric, with a wonderful help prompt

return array(
  0 => array('value' => value for value),
  // You'll usually want to stop here. Provide more values
  // if you want your 'default value' to be multi-valued:
  1 => array('value' => value for value),
  2 => ...
);
?>

To figure out the expected format, you can use the devel load tab provided by devel module on a profile_contact content page. This doesn't include the most vital piece of information - the associative array must return the key of the selection. So for instance, a select list option of

GB|United Kingdom
?>

the key will be GB For the country code example at Drupal 6: Country Field Select List on Registration setting Default by IP Address Detection this would be

return array(0 => array('value' => 'GB'));
?>

Now, if this was to be included in a PHP module it would need to reside in a hook_form_alter function.

function your_module_form_alter(&$form, &$form_state, $form_id) {

    if ($form_id == 'profile_contact_node_form') 
        $form['fieldgroup_name']['field_fieldname']['#default_value'][0]['value'] = 'GB';

}
?>

You will need to change a few values in here obviously - the function name to reflect your own module's name, and the fieldgroup_name (if the field is in a group) and field_fieldname indices.

blog terms

Drupal Drupal 6

Drupal 6: Country Field Select List on Registration Setting Default by IP Address Detection

nigel — Sun, 15 Jul 2012 16:02:18 +0000

Drupal 6: Country Field Select List on Registration Setting Default by IP Address Detection nigel Sun, 15/07/2012 - 17:02

Another powerful feature of Drupal is the ability to customise the user registration process by adding fields. These fields can be anything, but a worthwhile example would be address information with a country field select list the user can select their country from. Even better would be the ability for the system to detect the user's country and default the select list to that. That is what this tutorial sets out to achieve. It can't be accomplished purely by 'site building' with existing contributed modules - there is a small amount of custom PHP code required. This can be included in the configuration if you have PHP Snippets enabled on your site - or as I do here, stick all the code in a custom self-contained PHP module.

There are a number of contributed modules you will need to install:

Automatic Nodetitles
Token
CCK -> Content, Fieldgroup, Option Widgets, Text
Content Profile -> Content Profile Tokens, Content Profile User Registration
Country Codes API
IP 2 Country

These themselves may have dependencies I've forgotten to list - if your system prompts for any others, download, install and enable.

Create the Profile Contact Type

Firstly you need to create a Profile Contact content type. To help you, I've shown a screenshot to the left of the fields and checkbox selections you will need. The first point of note is the Automatic Title Generation. Since we don't want to encumber our poor user with a meaningless prompt for a title for their address, we need this mechanism to automatically generate the title without a prompt. We are using here a token replacement pattern for what the system will use.

Also note that there is no Body Field Label - since we don't want a body field either. So make sure you remove the defaulted body field label. Comments are disabled since they are meaningless, and finally you must tick the checkbox to use this content type as a content profile type.

Create the Fields

You will need to create the fields you wish to reside in the profile contact content type. This could include telephone numbers, home websites etc, and obviously a country field since this is the purpose of this exercise. The three fields I have created are Address1, Address2, and Country. Address1 and Address2 are simple textfields. The Country field is discussed further in the next screenshot.

Country Select List Field

The country list field is created using the select list option. You will need to stick a value or two in the allowed values list. It doesn't really matter what you put in here since the custom code will overwrite later, so I've just put a couple of values in.

Profile Contact - Content Profile

Once all the required fields are defined, you need to let the system know where to place the the fields - such as on a separate tab on the user profile, and of course the most important bit from our perspective - click the Use on Registration checkbox.

User Registration

If you now log off your account and attempt to register as a new user, you should see something like the image to the left if you've followed my instructions correctly.

Custom Code

So we now have our starting point for our custom development! We need code that does two things: 1. Populate the select list with all the countries; 2. Set a default value dependent upon the IP address of the user. select_country.info

; Id: $
name = "select_country"
description = "Select Country: Add country list to profile country field and set default value on IP address"
core = 6.x
php = 5.2
dependencies[] = token
dependencies[] = content
dependencies[] = countries_api
dependencies[] = ip2country
dependencies[] = content_profile
dependencies[] = auto_nodetitle

select_country.install

// Copyright @badzillacouk http://www.badzilla.co.uk
// Licence GPL. This program may be distributed as per the terms of GPL and all credits
// must be retained
//
// If you find this script useful, please consider a donation to help me fund my web presence
// and encourage me to develop more products to be placed under the terms of GPL
// To donate, go to http://www.badzilla.co.uk and click on the donation button
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 



function select_country_install() {

    db_query("UPDATE {system} SET weight = 100 WHERE `name` = 'select_country'");
}

?>

Note here that I've had to give a weight to this module to ensure it is one of the last to be called, i.e. after CCK and associated modules have done their work.
select_country.module

// Copyright @badzillacouk http://www.badzilla.co.uk
// Licence GPL. This program may be distributed as per the terms of GPL and all credits
// must be retained
//
// If you find this script useful, please consider a donation to help me fund my web presence
// and encourage me to develop more products to be placed under the terms of GPL
// To donate, go to http://www.badzilla.co.uk and click on the donation button
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 


function select_country_form_alter(&$form, &$form_state, $form_id) {

    if ($form_id == 'profile_contact_node_form') {
        $form['group_address']['field_country']['#default_value'][0]['value'] = ip2country_get_country($_SERVER['REMOTE_ADDR']);
        $form['group_address']['field_country']['#pre_render'] = array('select_country_options');
    }
}


function select_country_options($element) {

    $element['value']['#options'] = array('' => t('- None -')) + countries_api_get_array('iso2', 'printable_name');
    return $element;
}
?>

Completed Country Registration

So now when an attempt is made at registration, the select list has been extended (in width) to allow for the maximum country's length, and it has defaulted to my home country, United Kingdom

blog terms

Drupal Drupal 6

Drupal 6: Webform + Paypal Donations Integration

nigel — Thu, 05 Jul 2012 18:22:15 +0000

Drupal 6: Webform + Paypal Donations Integration nigel Thu, 05/07/2012 - 19:22

This module provides integration between the Drupal Webform module and Paypal donation buttons. This includes the facility to receive payment status responses from Paypal and record these in the webforms as a hidden field for audit / inspection later to ascertain whether payments were successful or refused. The module should be useful for charities and NGOs as a mechanism to collect donations from their followers.

The module was developed as a commission from a well-known NGO. The NGO was already utilising a SECPAY gateway on their 'Donate Now' webform, and required a radio button in the donation process for the user to select either the SECPAY credit card / debit card direct payment, or a Paypal payment. As a consequence, this module presupposes a SECPAY gateway is being used. It should be relatively trivial for even a low experience PHP / Drupal developer to remove this constraint if necessary from my code so the only option is Paypal, or I can be contacted directly and undertake the work at a small cost.

Usage

To ensure the module works correctly, the steps identified below should be followed closely, paying particular attention when requested to do so.

Paypal Donation Button Creation

You will need a donation button from the Paypal site. It is also recommended you create a Paypal sandbox account for test purposes before you 'go live'. By doing this you can satisfy yourself everything is working fine before you commence your campaign.

The navigation around the Paypal site is inordinately complex. To create a button in the UK (may vary depending upon your territory), do:

Log into your Paypal account;
Click on "Merchant Services";
Click on "Website Payments Standard";
Click on "Create Button Now";

This will take you to the button factory. Once you have changed the button type to 'Donations' your Step 1 screen should be filled in like below. Enter reasonable text for the Organisation name/service and for the Donation ID values. This will be very useful in the future when you have a whole bunch of buttons and you are having trouble distinguishing between them all.

Paypal Donation Button Step 1

Step 3 of the process will look like the screen below. This is where you need to add you own site address to the two URL fields I have partially pixelated out. The first URL is the address the user will be returned to once payment from Paypal has been collected. The second URL is the 'secret' URL that Paypal will use to send the payment status information to your site.

Paypal Donation Button Step 3

At the end of the process you will get a link to the button in the format:
https: //www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=xxxxxxxxxxxxxx
if you are using Paypal, and a URL prefixing the word 'sandbox' before 'paypal' in the address if you are using the test Sandbox system. You should copy these into your clipboard for later.

Installation of the paypal_webform Module

I'm assuming you know how to install a Drupal module :)

paypal_webform.info

; $Id: $
name = Paypal Webform
description = Adds the Paypal donation colleciton method to the donations page
core = 6.x
dependencies[] = webform
php = 5.2

paypal_webform.module

paypal_webform.module

// Copyright  www.badzilla.co.uk
// Author: www.badzilla.co.uk @badzillacouk
// All Drupal work undertaken - competitive hourly and daily rates
// 13/11/2011
// paypal_webform - Adds Paypal functionality to the single donation webform 

define('PAYPAL_PRODUCTION', 0);
define('PAYPAL_SANDBOX', 1);


global $paypal_webform;

$paypal_webform = array(array('url' => 'https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=xxxxxxxxxxxxx',
                                                    'listener' => 'ssl://www.paypal.com'),
                        array('url' => 'https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=xxxxxxxxxxxxx',
                                                    'listener' => 'ssl://www.sandbox.paypal.com'),
                        );

// Change this value dependent upon whether production, sandbox, or running in test mode on badzilla
define('PAYPAL_SYSTEM', PAYPAL_PRODUCTION);


/**
 * Implementation of hook_form_alter().
 */
function paypal_webform_form_alter($form, &$form_state, $form_id) {

    // locate the webform id and override
    if (strpos($form_id, 'webform_client_form_') === FALSE) 
        if (!$form_state['webform']['component_tree']['children'])
            return;

    $is_pay = FALSE;
    foreach($form_state['webform']['component_tree']['children'] as $child)
        if ($child['type'] == 'pay') {
            $is_pay = TRUE;
            break;
        }

    if (!$is_pay)
        return;

    // check whether there is a Paypal widget on this form
    if (!preg_match("#webform_client_form_(\d+)$#", $form_id, $match))
        return;

    if (!db_result(db_query("SELECT COUNT(*) FROM {webform_component} WHERE nid = %d AND form_key = 'payment_method'", $match[1])))
        return;

    // add theme
    $form['submitted']['payment_method']['#theme'] = 'paypal_webform_radio';

    // Knock out the title and use our own 
    $form['submitted']['payment_method']['#title'] = '';

    // after build so we can see which radio button was selected
    $form['#after_build'][] = 'paypal_webform_form_after_build';

    // add paypal submission 
    array_push($form['#submit'], 'paypal_webform_submit_redirect');

    //dsm($form, __FUNCTION__);

}



function paypal_webform_form_after_build($form, &$form_state) {

    //dsm($_SESSION);

    if (isset($form['#post']['submitted']['payment_method']) and $form['#post']['submitted']['payment_method'] == 'paypal') {
        // remove the secpay submit 
        if (($ind = array_search('webform_simple_payments_submit_redirect', $form['#submit'])) !== FALSE) {
            unset($form['#submit'][$ind]);
        }
    } elseif (isset($form['#post']['submitted']['payment_method']) and $form['#post']['submitted']['payment_method'] == 'cc_dd') {
        if (($ind = array_search('paypal_webform_submit_redirect', $form['#submit'])) !== FALSE) {
            unset($form['#submit'][$ind]);
        }
    }

    return $form;
}




/**
 * Implementation of hook_menu().
 */
function paypal_webform_menu() {

    $items['webform/submissions/paypal'] = array(
        'title' => 'Pay',
        'page callback' => 'drupal_get_form',
        'page arguments' => array('paypal_webform_submit_redirect'),
        'access callback' => TRUE,
        'type' => MENU_LOCAL_TASK,
    );

    $items['webform/submissions/paypal-response'] = array(
        'title' => 'Response',
        'page callback' => 'paypal_webform_response',
        'access callback' => TRUE,
        'type' => MENU_LOCAL_TASK,
    );

    $items['webform/submissions/paypal-listener'] = array(
        'title' => 'Listener',
        'page callback' => 'paypal_webform_listener',
        'access callback' => TRUE,
        'type' => MENU_LOCAL_TASK,
    );

    return $items;

}



function paypal_webform_submit_redirect($form, &$form_state) {
    global $paypal_webform;
   
    $_SESSION['webform_paypal_payment'] = array(
        'nid' => $form_state['values']['details']['nid'],
        'sid' => $form_state['values']['details']['sid'],
    );


    drupal_goto($paypal_webform[PAYPAL_SYSTEM]['url']);

}


function paypal_webform_listener() {
    global $paypal_webform;

    $header = "";
    $emailtext = "";

    // Read the post from PayPal and add 'cmd'
    $req = 'cmd=_notify-validate';
    if(function_exists('get_magic_quotes_gpc'))
        $get_magic_quotes_exists = true;

    foreach ($_POST as $key => $value) {
        if($get_magic_quotes_exists == true && get_magic_quotes_gpc() == 1) {
            $value = urlencode(stripslashes($value));
        } else {
            $value = urlencode($value);
        }
        $req .= "&$key=$value";
    }

    // Post back to PayPal to validate
    $header .= "POST /cgi-bin/webscr HTTP/1.0\r\n";
    $header .= "Content-Type: application/x-www-form-urlencoded\r\n";
    $header .= "Content-Length: " . strlen($req) . "\r\n\r\n";
    $fp = fsockopen ($paypal_webform[PAYPAL_SYSTEM]['listener'], 443, $errno, $errstr, 30);

    if (!$fp) { // HTTP ERROR
    } else {
        // NO HTTP ERROR
        fputs($fp, $header . $req);
        //while (!feof($fp)) {
        $res = fgets($fp);
        fclose ($fp);
        
        // create the output record
        $out = sprintf("Amount %s %s %s", $_POST['mc_currency'], $_POST['mc_gross'], $_POST['payment_status']);

        // now try and find the correct record in the database by using the email address from Paypal
        // It would kill the server to try and do this in one sql statement so it has been chunked for performance reasons
        $found = FALSE;
        $res = db_query("SELECT sid FROM {webform_submitted_data}
                         INNER JOIN {webform_component} ON {webform_submitted_data}.nid = {webform_component}.nid
                         INNER JOIN {webform_submissions} USING (sid)
                         WHERE data = '%s' AND form_key = 'email_address' 
                         ORDER BY submitted DESC", $_POST['payer_email']);

        while($ret = db_fetch_object($res)) { 
            $res2 = db_query("SELECT cid, nid FROM {webform_component} INNER JOIN {webform_submissions} USING (nid) 
                              WHERE sid = %d AND form_key = 'payment_response'", $ret->sid);
            while($ret2 = db_fetch_object($res2)) {
                $found = TRUE;
                break 2;
            }
        }

        // HAve we found a record to write?
        if ($found == TRUE and isset($ret2)) {
            db_query("UPDATE {webform_submitted_data} SET `data` = '%s' WHERE nid = %d AND sid = %d and cid = %d",
                      $out, $ret2->nid, $ret->sid, $ret2->cid);
        } else {
            watchdog("paypal_webform", 
                     "Unreconciled Paypal payment from @email with data @data", 
                     array('@email' => $_POST['payer_email'], '@data' => $out), 
                     WATCHDOG_NOTICE);
        }

    }
}



function paypal_webform_response() {

    if (isset($_SESSION['webform_paypal_payment']['nid']) 
        and $_SESSION['webform_paypal_payment']['nid'] 
        and isset($_SESSION['webform_paypal_payment']['sid']) 
        and $_SESSION['webform_paypal_payment']['sid']) {

        // redirect to the thank you screen
        drupal_goto('node/' . $_SESSION['webform_paypal_payment']['nid'] . '/done', 'sid=' . $_SESSION['webform_paypal_payment']['sid']);

    } else {
        watchdog('paypal_webform', t('Cannot reconcile response from Paypal with database entries'), NULL, WATCHDOG_ERROR);
        die; 
    }

}



/**
 * Implementation of hook_theme().
 */
function paypal_webform_theme() {

    return array('paypal_webform_radio' => array('arguments' => array('element' => NULL)));
}



function theme_paypal_webform_radio($element) {

    drupal_add_css(drupal_get_path('module', 'paypal_webform') . "/css/webform-cc-paypal.css");
    
    $output = drupal_render($element);

    // get the images directory
    $image_dir = drupal_get_path('module', 'paypal_webform') . "/images/";
    $credit_img = ". $image_dir . "credit-cards.gif\" />";
    $paypal_img = ". $image_dir . "paypal.gif\" />";

    $output = '';

    $output .= "\n";
    $output .= "\n";

    $output .= "\n";
    $output .= "\n";
    $output .= " Credit / Debit cards\n";
    $output .= "\n";
    $output .= "\n";
    $output .= $credit_img;
    $output .= "\n";
    $output .= "\n";
    $output .= "\n";
    $output .= "\n";
    $output .= " Paypal\n";
    $output .= "\n";
    $output .= "\n";
    $output .= $paypal_img;
    $output .= "\n";
    $output .= "\n";
    $output .= "\n";


    return $output;
}
?>

images/credit-cards.gif

images/paypal.gif

.module file Configuration

You must now copy the button URLs you created in Paypal (and perhaps Sandbox) at the top of the paypal_webform.module code. It should be obvious where they go - they are replacing the two URLS in the $paypal_webform array. In addition, you need to set the enumerator type to either use the Paypal or the Sandbox URL by changing the

define('PAYPAL_SYSTEM', PAYPAL_PRODUCTION);
?>

accordingly.

Webform creation

You can now make your first webform with Paypal donations available. Below is a sample webform - note the "Select payment method" selection drop down, and the "Payment Response" hidden field.

Sample Webform

The "Select payment method" component should be filled in as below, paying particular attention to the ringed values.

Select payment method

The "Payment Response" component stores the returned values from Paypal and must be as ringed below.

The Finished Webform

If everything has gone well, you should see your completed webform looking something like the image below. If the user selects a Paypal payment type, they will be whisked off to Paypal to effect the payment

Select payment method
The "Payment Response" component stores the returned values from Paypal and must be as ringed below.

Next Steps

Due to severe budget constraints, there are a number of activities that weren't completed to my satisfaction, but really aught to be.

As mentioned previously, there is a small dependency on there being another gateway in use (in this case SECPAY) and a radio button is added to provide a choice. It would be good not to have that requirement
The configuration is messy. At the moment, Paypal button URLs need to be pasted into the PHP code
Linked to the above concern, there is no convenient way of switching between buttons (i.e. production and sandbox)

These problem areas, as mentioned, were forced due to the lack of complete sponsorship. If you or your organisation would like to pay to have this tidied up, drop me a line

blog terms

Drupal Drupal 6

Drupal 6: Silverpop AddRecipient Module

nigel — Tue, 26 Jun 2012 16:47:41 +0000

Drupal 6: Silverpop AddRecipient Module nigel Tue, 26/06/2012 - 17:47

This module (which requires the Silverpop XML API module to be installed) provides the facility to add recipients to a Silverpop database. By default this is through a 'Subscribe now' block or node, both of which can be themed. In addition, there is functionality to delete a recipient from a Silverpop database. User permissions (for the nodes) and block permissions (for the blocks) can control the visibility of the forms.

Installation

Installation is by the usual Drupal mechanism. Once the module is installed, permissions should be set by going to admin/user/permissions. It is important to ensure that these are set correctly to prevent unauthorised access through to the Silverpop API.

Usage

To create a form to capture an email address, go to node/add/silverpop-subscribe-now. You will need to provide a title and a database id. This will provide both a unique block and a node. To make the block visible you will need to go to admin/build/block/list and configure as appropriate. The blocks can be identified by their nid or by the titles they were created with.

Those uses with the correct permissions will see a link to silverpop/remove_recipient in the navigation menu (providing this itself is visible on your system). Use the form from this link to delete email addresses from a database.

Limitations

This system captures email addresses which can be useful for newsletters and campaigns. It does not capture other information such as names / titles etc. It would be possible to re-factor the code to do this as an exercise at a later date.

The RemoveRecipient API call assumes there is only one key, of Email, in the database and will not work should this not be the case.

silverpop_addrecipient.info

version = "6.x-1.00"
name = "Silverpop AddRecipient"
description = "Silverpop Add Recipient through a subscribe now form on a block"
core = 6.x
php = 5.2
package = "silverpop"
dependencies[] = "silverpop"

silverpop_addrecipient.install

/**
 * Implementation of hook_install().
 */
function silverpop_addrecipient_install() {

    drupal_install_schema('silverpop_addrecipient');

}



/**
* Implementation of hook_uninstall().
*/
function silverpop_addrecipient_uninstall() {

    drupal_uninstall_schema('silverpop_addrecipient');
}



/**
* Implementation of hook_schema().
*/
function silverpop_addrecipient_schema() {

    $schema['silverpop_subscribe_now'] = array(
        'fields' => array(
            'vid' =>            array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
            'nid' =>            array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
            'sp_db' =>          array('type' => 'varchar', 'length' => 255, 'not null' => FALSE),
            ),
        'unique keys' => array(
            'nid_vid' =>        array('nid', 'vid'),
            ),
        'indexes' => array(
            'nid' =>            array('nid'),
        ),
        'primary key' => array('vid'),
    );

    return $schema;
}
?>

silverpop_addrecipient.module

// Copyright @badzillacouk http://www.badzilla.co.uk
// Licence GPL. This program may be distributed as per the terms of GPL and all credits
// must be retained
//
// If you find this script useful, please consider a donation to help me fund my web presence
// and encourage me to develop more products to be placed under the terms of GPL
// To donate, go to http://www.badzilla.co.uk and click on the donation button
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 



/**
 * Implements hook_node_info().
 */
function silverpop_addrecipient_node_info() {

    return array(
        'silverpop_subscribe_now' => array(
            'name' => t('Silverpop Subscribe Now Block'),
            'module' => 'silverpop_addrecipient',
            'description' => t("Silverpop Subscribe Now Block to capture new email addresses and add to Silverpop"),
            'has_title' => TRUE,
            'title_label' => t('Silverpop Subscribe Now Block Title'),
            'has_body' => FALSE,
            ),
        );
}



/**
 * implements hook_insert().
 */
function silverpop_addrecipient_insert($node) {

    db_query(
        'INSERT INTO {silverpop_subscribe_now} (vid, nid, sp_db) '
        ."VALUES (%d, %d, '%s')",
            $node->vid,
            $node->nid,
            $node->sp_db);
}



/**
 * Implements hook_delete().
 */
function silverpop_addrecipient_delete($node) {

    db_query('DELETE FROM {silverpop_subscribe_now} WHERE nid = %d', $node->nid);
}




/**
 * This implementation just handles deleting node revisions.
 * Implements hook_nodeapi().
 */
function silverpop_addrecipient_nodeapi(&$node, $op, $teaser, $page) {

    if ($op == 'delete revision' and $type->type == 'silverpop_addrecipient') 
        db_query('DELETE FROM {silverpop_subscribe_now} WHERE vid = %d', $node->vid);
}




/**
 * implements hook_update().
 */
function silverpop_addrecipient_update($node) {

    db_query("UPDATE {silverpop_subscribe_now} SET sp_db = '%s'WHERE vid = '%d'",
                $node->sp_db);
}



/**
 * Implementation of hook_load().
 */
function silverpop_addrecipient_load($node) {

    return db_fetch_object(db_query("SELECT * FROM {silverpop_subscribe_now} WHERE vid = %d", $node->vid));
}



/**
 * Implements hook_perm()
 */
function silverpop_addrecipient_perm() {

    return array(
        'create silverpop_subscribe_now',
        'edit silverpop_subscribe_now',
        'delete silverpop_subscribe_now',
        'view silverpop_subscribe_now',
    );
}




/**
 * Implements hook_access()
 */
function silverpop_addrecipient_access($op, $node, $account) {

    switch ($op) {
        case 'create':
            return user_access('create silverpop_subscribe_now', $account);
        case 'update':
            return user_access('edit silverpop_subscribe_now', $account);
        case 'delete':
            return user_access('delete silverpop_subscribe_now', $account);
        case 'view':
            return user_access('view silverpop_subscribe_now', $account);

    }
}



/**
 * Implementation of hook_view().
 */
function silverpop_addrecipient_view($node, $teaser = FALSE, $page = FALSE) {

    if (!$teaser) {
        $node = node_prepare($node, $teaser);
        $node->content['form'] = array('#value' => drupal_get_form('silverpop_subscribe_now_form', $node));
    }

    return $node;
}


/**
 * Implementation of hook_form().
 */
function silverpop_addrecipient_form(&$node, $form_state) {

    $form['title'] = array(
        '#type' => 'textfield',
        '#maxlength' => 250,
        '#title' => $type->title_label,
        '#required' => TRUE,
        '#default_value' => $node->title,
        '#weight' => -10,
    );

    $form['sp_db'] = array(
        '#type' => 'textfield',
        '#maxlength' => 255,
        '#title' => t('Silverpop database id'),
        '#required' => TRUE,
        '#description' => t('Silverpop database id'),
        '#default_value' => $node->sp_db ? $node->sp_db : '',
        '#weight' => 0,
    );

    return $form;
}



/**
 * Implementation of hook_block().
 */
function silverpop_addrecipient_block($op = 'list', $delta = 0, $edit = array()) {

    switch($op) {
        case 'list':
            $res = db_query("SELECT n.nid, r.title FROM {node} AS n INNER JOIN {node_revisions} AS r
                             USING (vid) WHERE type = 'silverpop_subscribe_now' AND status = 1");

            while($ret = db_fetch_object($res)) 
                $block[$ret->nid]['info'] = t('Silverpop Subscribe Now: @title [nid:@nid]',
                                    array('@title' => $ret->title, '@nid' => $ret->nid));
            
            break;

        case 'view':
            if ($node = node_load($delta)) {
                $block['content'] = drupal_get_form('silverpop_subscribe_now_form', $node);
                $block['subject'] = $node->title;
            }

            break;

        default:
            break;
    }

    return $block;
}



// Forms for user input 
function silverpop_subscribe_now_form($form_state, $node_params) {

    $form['email_address'] = array(
        '#type' => 'textfield',
        '#maxlength' => 255,
        '#title' => t('Email address'),
        '#size' => 15,
        '#required' => TRUE,
    );

    $form['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Subscribe'),
    );

    $form['#validate'][] = 'silverpop_subscribe_now_form_validate';
    $form['#submit'][] = 'silverpop_subscribe_now_form_submit';

    return $form;
}





function silverpop_subscribe_now_form_validate($form, &$form_state) {

    if (!valid_email_address($form_state['values']['email_address']))
        form_set_error('email_address', t('Please enter a valid Email address'));
}



function silverpop_subscribe_now_form_submit($form, &$form_state) {

    // Construct the XML for the Silverpop API call
    $dom = new DOMDocument;
    $list_id = $dom->createTextNode($form['#parameters'][2]->sp_db);
    $list = $dom->createElement('LIST_ID');
    $cfrom_text = $dom->createTextNode('1');
    $cfrom = $dom->createElement('CREATED_FROM');
    $column = $dom->createElement('COLUMN');
    $name_text = $dom->createTextNode('EMAIL');
    $name = $dom->createElement('NAME');
    $value_text = $dom->createTextNode($form_state['values']['email_address']);
    $value = $dom->createElement('VALUE');
    $method = $dom->createElement('AddRecipient');

    $list->appendChild($list_id);
    $cfrom->appendChild($cfrom_text);
    $name->appendChild($name_text);
    $value->appendChild($value_text);
    $method->appendChild($list);
    $method->appendChild($cfrom);
    $method->appendChild($column);
    $column->appendChild($name);
    $column->appendChild($value);
    $dom->appendChild($method);

    module_load_include('inc', 'silverpop', 'silverpop_xml');
    $addrecipient = new silverpop_xml($dom, FALSE);
    list($retcode, $response) = $addrecipient->apicall();

    $msg = '';
    if ($retcode)
        $msg = t('Thanks! You have now been suscribed to the mailing list');
    else if (is_object($response) and 
             isset($response->getElementsByTagName('errorid')->item(0)->nodeValue) and 
             $response->getElementsByTagName('errorid')->item(0)->nodeValue == 122)
        $msg = t('Thanks, but you are already subscribed');
    else
        $msg = t('Sorry, unable to subscribe you at this present time');

    drupal_set_message($msg);
}



/**
 * Implementation of hook_theme().
 */
function silverpop_addrecipient_theme() {

    $ret['silverpop_subscribe_now_form'] = array(
            'arguments' => array('form' => NULL));

    $ret['silverpop_remove_recipient_form'] = array(
            'arguments' => array('form' => NULL));

    return $ret;
}



function theme_silverpop_subscribe_now_form($form) {

    $output = '';

    $output .= "To subscribe to our newsletter, please enter your Email address below";
    $output .= drupal_render($form['email_address']);
    $output .= drupal_render($form['submit']);

    $output .= drupal_render($form);

    return $output; 
}



/**
 * Implementation of hook_menu().
 */
function silverpop_addrecipient_menu() {

    $items['silverpop/remove_recipient'] = array(
        'title' => t('Silverpop Remove Recipient'),
        'description' => t('Removal of recipients from Silverpop'),
        'page callback' => 'drupal_get_form',
        'page arguments' => array('silverpop_remove_recipient_form'),
        'access arguments' => array('delete silverpop_subscribe_now'),
        'type' => MENU_NORMAL_ITEM,
    );

    return $items;
}



function silverpop_remove_recipient_form() {

    $form['sp_db'] = array(
        '#type' => 'textfield',
        '#maxlength' => 250,
        '#title' => t('Silverpop database id'),
        '#required' => TRUE,
        '#description' => t('Silverpop database id'),
        '#default_value' => $node->sp_db ? $node->sp_db : '',
        '#weight' => 0,
    );

    $form['email'] = array(
        '#type' => 'textfield',
        '#maxlength' => 250,
        '#title' => t('Email address'),
        '#description' => t('Email address to remove from the Silverpop database'),
        '#required' => TRUE,
        '#weight' => 10,
    );

    $form['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Submit'),
        '#weight' => 20,
    );

    $form['#submit'][] = 'silverpop_remove_recipient_form_submit';
    $form['#validate'][] = 'silverpop_remove_recipient_form_validate';

    return $form;
}



function silverpop_remove_recipient_form_validate($form, &$form_state) {

    if (!valid_email_address($form_state['values']['email']))
        form_set_error('email', t('Please enter a valid Email address'));
}



function silverpop_remove_recipient_form_submit($form, &$form_state) {

    // Construct the XML for the Silverpop API call
    $dom = new DOMDocument;
    $list_id = $dom->createTextNode($form_state['values']['sp_db']);
    $list = $dom->createElement('LIST_ID');

    $email_text = $dom->createTextNode($form_state['values']['email']);
    $email = $dom->createElement('EMAIL');

    $method = $dom->createElement('RemoveRecipient');

    $list->appendChild($list_id);
    $email->appendChild($email_text);
    $method->appendChild($list);
    $method->appendChild($email);

    $dom->appendChild($method);

    module_load_include('inc', 'silverpop', 'silverpop_xml');
    $removerecipient = new silverpop_xml($dom, TRUE);
    list($retcode, $response) = $removerecipient->apicall();

    $msg = '';
    if ($retcode)
        $msg = t('Email address succesfully deleted from the specified database');
    else if (is_object($response) and 
             isset($response->getElementsByTagName('errorid')->item(0)->nodeValue) and 
             $response->getElementsByTagName('errorid')->item(0)->nodeValue == 138)
        $msg = t('The email address you specified does not exist in the Silverpop database');
    else
        $msg = t('Sorry, the removal of the email address failed. Please contact your administrator');

    drupal_set_message($msg);
}


function theme_silverpop_remove_recipient_form($form) {

    $output = '';

    $output .= "To remove an email address from a Silverpop database, please use the form below";
    $output .= drupal_render($form['sp_db']);
    $output .= drupal_render($form['email']);
    $output .= drupal_render($form['submit']);

    $output .= drupal_render($form);

    return $output; 
}
?>

blog terms

Drupal Drupal 6

Drupal 6: Silverpop XML API Module

nigel — Tue, 26 Jun 2012 16:40:15 +0000

Drupal 6: Silverpop XML API Module nigel Tue, 26/06/2012 - 17:40

This module integrates Drupal with the Silverpop Engaging Marketing Solutions XML API. So what does it do? On its own, actually very little. It is only of use to developers wishing to write code to interrogate the Silverpop back-end. This module provides the handshaking mechanism between a developer's code and Silverpop. There are currently two published and documented Silverpop APIs, viz SOAP API and XML API. This module has been built to use the XML API. There may well be detail differences between the two APIs so prospective developers should undertake the necessary research to ensure that the XML API delivers to their requirements.

The module is installed in the normal Drupal way. If you are unsure how to accomplish this, you probably don't have the prerequisite skills yet to use this module. Once it has been installed and enabled it will require configuration at admin/settings/silverpop. You will require login credentials (username and password) for most of the Silverpop API calls (but crucially not all). You will also require the url on the Silverpop system to where the API calls are directed. This is usually of the format api{n}.silverpop.com where {n} is a small integer, but you should check with your Silverpop contact. You should also configure the user permissions for Silverpop administration at admin/user/persmissions.

Using the Interface

The best way of learning how to use this interface is to check out the function silverpop_get_list_meta_data which retrieves meta data for a particular Silverpop database. It is included in the silverpop.module. Note: This is the only API call included in this module and can be used with your code for test purposes.

If you look at the silverpop_get_list_meta_data function you will note that the XML is constructed using the DOMDocument class. This would be the text book approach to building your own XML, but you could of course just assign strings. When you are constructing this XML, you should not include the Envelope + Body nodes since this module automatically does this for you.

This module returns an array back to the caller. The first element is a boolean which if TRUE says the call to Silverpop was successful. A NULL/FALSE value says there was a failure. The second array element is the DOMDocument object returned by Silverpop. You do not need to worry about parsing the XML and writing error logs with a returned error diagnostic / code - this module does it for you. The object is passed back whether there is an error or not in case the calling function needs the information provided in it.

Should you have any problems, your first port of call should be your Drupal website's error log. All failed calls are entered into the watchdog table and should give you a very good clue as to where the issues are.

Other Silverpop Modules

I have written a Silverpop AddRecipient Module which uses this module for interfacing with Silverpop.

silverpop.info

version = "6.x-1.00"
name = "Silverpop"
description = "Silverpop API Integration module"
core = 6.x
php = 5.2
package = "silverpop"

silverpop.module

// Copyright @badzillacouk http://www.badzilla.co.uk
// Licence GPL. This program may be distributed as per the terms of GPL and all credits
// must be retained
//
// If you find this script useful, please consider a donation to help me fund my web presence
// and encourage me to develop more products to be placed under the terms of GPL
// To donate, go to http://www.badzilla.co.uk and click on the donation button
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 





/**
 * Implementation of hook_menu().
 *
 */
function silverpop_menu() {

    $items = array();
    $items['admin/settings/silverpop'] = array(
        'title' => 'Silverpop',
        'description' => t('Silverpop API Settings'),
        'page callback' => 'drupal_get_form',
        'page arguments' => array('silverpop_admin_settings_form'),
        'access arguments' => array('administer silverpop'),
        'type' => MENU_NORMAL_ITEM,
    );

    return $items;
}



/**
 * Implementation of hook_perm().
 *
 */
function silverpop_perm() {
    
    return array('administer silverpop');
}



function silverpop_admin_settings_form() {

    $form['silverpop_endpoint'] = array(
        '#type' => 'textfield',
        '#title' => t('Endpoint'),
        '#description' => t('The url to the Silverpop API endpoint.'),
        '#size' => 40,
        '#maxlength' => 255,
        '#required' => TRUE,
        '#default_value' => variable_get('silverpop_endpoint', NULL),
    );

    $form['silverpop_userid'] = array(
        '#type' => 'textfield',
        '#title' => t('Username'),
        '#description' => t('Silverpop username.'),
        '#size' => 40,
        '#maxlength' => 255,
        '#default_value' => variable_get('silverpop_userid', NULL),
    );

    $form['silverpop_password'] = array(
        '#type' => 'password',
        '#title' => t('Password'),
        '#description' => t('Silverpop password.'),
        '#size' => 40,
        '#maxlength' => 255,
        '#default_value' => variable_get('silverpop_password', NULL),
    );

    return system_settings_form($form);
}




function silverpop_get_list_meta_data($listid) {

    // Construct the XML for the Silverpop API call
    $dom = new DOMDocument;
    $list_id = $dom->createTextNode($listid);
    $list = $dom->createElement('LIST_ID');

    $method = $dom->createElement('GetListMetaData');

    $list->appendChild($list_id);
    $method->appendChild($list);
    $dom->appendChild($method);

    module_load_include('inc', 'silverpop', 'silverpop_xml');
    $get_list_meta_data = new silverpop_xml($dom, TRUE);
    return $get_list_meta_data->apicall();
}

?>

silverpop_xml.inc

// Copyright @badzillacouk http://www.badzilla.co.uk
// Licence GPL. This program may be distributed as per the terms of GPL and all credits
// must be retained
//
// If you find this script useful, please consider a donation to help me fund my web presence
// and encourage me to develop more products to be placed under the terms of GPL
// To donate, go to http://www.badzilla.co.uk and click on the donation button
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 



class silverpop_xml {

    private $wrapper;
    private $login_required;
    private $endpoint;
    private $userid;
    private $password;
    private $sessionid;


    // Silverpop outgoing API call
    // Pass a @body DOMDocument without the Envelope/Body nodes
    // And a TRUE / FALSE depending upon whether a jsession is requred or not
    public function __construct($body, $login_required = FALSE) {

        // if we don't have a url, not much point in progressing
        if (($this->endpoint = variable_get('silverpop_endpoint', NULL)) == NULL)
            return array(NULL);

        // ditto credentials if required
        if ($login_required) {
            if (($this->userid = variable_get('silverpop_userid', NULL)) == NULL)
                return array(NULL);  
            if (($this->password = variable_get('silverpop_password', NULL)) == NULL)
                return array(NULL);
        }

        // Create the outgoing xml.
        $this->wrapper = $this->_build_envelope($body);
        $this->login_required = $login_required;
    }


    // Top level API Call - all calling functions must go through this and not the lower-level function
    // Returns an array: First value FALSE or TRUE on success, and second value the DOMDocument response
    // (if converting the response to XML was possible)
    public function apicall() {

        $ret = array();

        if ($this->login_required)
            if (!$this->_login())
                return $ret;

        $ret = $this->_do_call();

        if ($this->login_required)
            $this->_logout();

        return $ret;
    }


    // build the login call to get the session id
    private function _login() {

        $dom = new DOMDocument;
        $user_text = $dom->createTextNode($this->userid);
        $user = $dom->createElement('USERNAME');

        $password_text = $dom->createTextNode($this->password);
        $password = $dom->createElement('PASSWORD');

        $method = $dom->createElement('Login');

        $user->appendChild($user_text);
        $password->appendChild($password_text);
        $method->appendChild($user);
        $method->appendChild($password);
        $dom->appendChild($method);

        list($retcode, $response) = $this->_do_call($this->_build_envelope($dom));

        // extract the sessionid if it is available
        if (!$retcode) 
            return NULL;

        if (is_object($response) and isset($response->getElementsByTagName('SESSIONID')->item(0)->nodeValue)) {
            $this->sessionid = $response->getElementsByTagName('SESSIONID')->item(0)->nodeValue;
            return TRUE;
        }

        return NULL;
    }


    // build the logout call
    private function _logout() {

        $dom = new DOMDocument;
        $method = $dom->createElement('Logout');
        $dom->appendChild($method);

        $this->_do_call($this->_build_envelope($dom));

        return TRUE;
    }


    // build the xml envelope
    // Pass the inner method and paramters as a DOMDocument
    // Return the stringified xml
    private function _build_envelope($inner) {

        // Create the outgoing xml.
        // First create the outer wrapper
        $wrapper = new DOMDocument;
        $envelope = $wrapper->createElement('Envelope');
        $body_tag = $wrapper->createElement('Body');

        $wrapper->appendChild($envelope);
        $envelope->appendChild($body_tag);

        // Now insert the passed parameters into this wrapper
        $node = $inner->documentElement;
        $node = $wrapper->importNode($node, true);
        $wrapper->getElementsByTagName('Body')->item(0)->appendChild($node);

        return $wrapper->saveXML();
    }


    // low level API call not available to clients
    private function _do_call($wrapper = NULL) {
    
        // ok now ready to go
        if (!$wrapper)
            $data = "xml=" . urlencode($this->wrapper);
        else
            $data = "xml=" . urlencode($wrapper);

        // open connection
        // port 80, timeout of 20
        if (($sock = @fsockopen($this->endpoint, 80, $errno, $errstr, 20)) == NULL) {
            watchdog('silverpop', 'Could not connect to host with error number: @errno and diagnostic: @errstr', 
                    array('@errno' => $errno, '@errstr' => $errstr), WATCHDOG_ERROR);
            return array();
        }

        // outgoing message
        $jsessionid = '';
        if ($this->login_required)
            $jsessionid = ';jsessionid=' . $this->sessionid;
        fputs($sock, "POST /servlet/XMLAPI{$jsessionid} HTTP/1.1\n");
        fputs($sock, "Host: " . $this->endpoint . "\n");
        fputs($sock, "Content-type: application/x-www-form-urlencoded\n");
        fputs($sock, "Content-length: " . strlen ($data) . "\n");
        fputs($sock, "Connection: close\n\n");
        fputs($sock, $data);

        // incoming
        $buffer = "";
        while (!feof($sock))
            $buffer .= fgets($sock);

        fclose($sock);

        // Ok so was there an error? If so, stick it in the log
        if (($pos = stripos($buffer, '')) === NULL) {
            watchdog('silverpop', 'Unspecified error diagnostic. Output dump: @dump', array('@dump' => $buffer), WATCHDOG_ERROR);
            return array(NULL);
        } else {
            $epos = stripos($buffer, '') + strlen('');
            $b_body = substr($buffer, $pos, $epos - $pos);

            $response = new DOMDocument;
            $response->loadXML($b_body);

            $success = $response->getElementsByTagName('SUCCESS');
            $fault = $response->getElementsByTagName('FaultString');
            $errorid = $response->getElementsByTagName('errorid');

            if ($success->length and strtoupper($response->getElementsByTagName('SUCCESS')->item(0)->nodeValue) == 'FALSE') {
                $err_arr = array();
                $msg = 'API call failed.';

                // did we get an error message?
                if ($fault->length) { 
                    $msg .= ' Diagnostic: @fault'; 
                    $err_arr['@fault'] = $response->getElementsByTagName('FaultString')->item(0)->nodeValue; 
                }

                // did we get an error number?
                if ($errorid->length) {
                    $msg .= ' Error code: @errorid';
                    $err_arr['@errorid'] = $response->getElementsByTagName('errorid')->item(0)->nodeValue; 
                }
                    
                watchdog('silverpop', $msg, $err_arr, WATCHDOG_ERROR);
                return array(FALSE, $response);
            }
        }

        return array(TRUE, $response);  
    }



}

?>

blog terms

Drupal Drupal 6

Drupal 6: user_badges_taxonomy Module

nigel — Sun, 15 Jan 2012 20:21:29 +0000

Drupal 6: user_badges_taxonomy Module nigel Sun, 15/01/2012 - 20:21

The motivation for this module came from a shortcoming of the functionality of the user_badges module and the thread http://drupal.org/node/1144296 questioning the usage of the vocabulary feature in the user_badges module. It appears that this enables the assignment of badges to users for arbitrary achievements. For instance, a client of mine is a political campaigning organisation and it would be cool to assign badges to those activists who attend campaigns. Similarly, badges could be assigned according to a geographic location (as in my example below) or indeed anything else an administrator can think of. This can be linked to Drupal's taxonomy system - or to be more precise, the terms within a selected vocabulary.

The problem with user_badges is there is no mechanism for assigning badges to individuals once a vocabulary has been selected in user_badge settings. The module I have created below, user_badges_taxonomy addresses this. The screenshots will guide you through the process, then the source code is listed, and then the tar file is available for download.

Firstly, create a new taxonomy vocabulary at admin/content/taxonomy/add/vocabulary. Then create individual taxonomy terms which will reflect the arbitrary badges you intend assigning to your users. The image shows I have chosen geographical location for staff offices, but of course it could be anything and is only limited by your imagination. The list can be seen at admin/content/taxonomy/{tid}

This vocabulary now needs to be set in user_badges. So go to admin/user/user_badges/settings and click the radio button of the vocabulary you wish to use

Create the arbitrary badges for achievements by going to admin/user/user_badges/add. There is a drop down selection box to pick the taxonomy term you wish to assign this particular badge

Check that you have permissions to use my user_badges_taxonomy module by going to admin/user/permissions. Providing you have permission you will be able to navigate to the profile of any user at user/{uid}/badge_taxomony where you will see a list of all the arbitrary achievement badges you have created. These can be selected / deselected as appropriate

You can now navigate to user/{uid}/badges (again if you have the correct permissions) and see the fruit of your labour

To Do

It would be good to assign a userweight to these achievement badges. There is a column in the database table to support this, so that functionality should be added to my code at some stage. In addition it would be cool to show a picture of the badge along with the checkbox to aid those responsible for assigning the badges.

Source Code

user_badges_taxonomy.info

name = User Badges Taxonomy
description = Assign taxonomy terms to a badge in a user's profile. Useful for arbitrary assignment of badges for achievements
dependencies[] = user_badges
core = 6.x

user_badges_taxonomy.module

// Copyright @badzillacouk //" title="www.badzilla.co.uk
//">www.badzilla.co.uk
// Licence GPL. This program may be distributed as per the terms of GPL and all credits
// must be retained
//
// If you find this script useful, please consider a donation to help me fund my web presence
// and encourage me to develop more products to be placed under the terms of GPL
// To donate, go to http://www.badzilla.co.uk and click on the donation button
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 




/**
* Implementation of hook_menu().
*/
function user_badges_taxonomy_menu() {

    $items = array();
    $items['user/%/badge_taxomony'] = array(
        'title'                 => 'Assign Achievement Badges',
        'access callback'       => 'user_access',
        'access arguments'      => array('create taxonomy user badges'),
        'page arguments'        => array(1),
        'page callback'         => 'user_badges_taxonomy_pre_form',
        'type'                  => MENU_LOCAL_TASK,
        'weight'                => 3,
        );

    return $items;
}




/**
* Implementation of hook_perm().
*/
function user_badges_taxonomy_perm() {

    return array('create taxonomy user badges');
}





function user_badges_taxonomy_pre_form($uid) {

    $nothing = t('There are currently no achievement badges available');

    $vid = variable_get('user_badges_vid', NULL);

    // Are there any badges with taxonomy terms to display or not?
    if (!db_result(db_query("SELECT COUNT(*) FROM {user_badges_badges} WHERE tid <> 0")))
        $out = $nothing;
    elseif (!$vid or !count($tree = taxonomy_get_tree($vid, 0, -1, 1)))
        $out = $nothing;
    else 
        $out = drupal_get_form('user_badges_taxonomy_form', $tree, $uid);

    return $out;
}



/**
* Implementation of hook_form().
*/
function user_badges_taxonomy_form($form_state, $tree, $uid) {

    $form = array();
    $options = array();
    $defaults = array();

    // create the checkbox list by looping through the tree
    foreach($tree as $branch) {
            if ($obj = db_fetch_object(db_query("SELECT bid, name FROM {user_badges_badges} WHERE tid = %d", $branch->tid))) {
                $options[$obj->bid] = $obj->name;

                // set default after checking db
                if (db_result(db_query("SELECT COUNT(*) FROM {user_badges_badges} 
                                        INNER JOIN {user_badges_user} USING (bid)
                                        WHERE bid = %d AND uid = %d", $obj->bid, $uid)))
                    $defaults[$obj->bid] = $obj->bid;
        }
    }


    $form['terms'] = array(
        '#type' => 'checkboxes',
        '#options' => $options,
        '#title' => t('Achievement Badges'),
        '#default_value' => $defaults,
    );

    $form['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Submit'),
    );  

    $form['#submit'][] = 'user_badges_taxonomy_form_submit';
    
    return $form;
}



function user_badges_taxonomy_form_submit($form, &$form_state) {

    // loop through all the badges and set / unset as applicable
    foreach($form_state['values']['terms'] as $key => $value) {
        // Determine whether currently exists
        $count = db_result(db_query("SELECT COUNT(*) FROM {user_badges_user} WHERE uid = %d AND bid = %d",
                                $form['#parameters'][3], $key));

        // four possible situations:
        // 1. no db row and not checked = do nothing
        // 2. no db row and checked = add record
        // 3. db row and not checked = delete record
        // 4. db row and checked = do nothing
        if (!$count and $value)
            db_query("INSERT INTO {user_badges_user} SET uid = %d, bid = %d, type = 'Vocabulary'", $form['#parameters'][3], $key);

        if ($count and !$value)
            db_query("DELETE FROM {user_badges_user} WHERE uid = %d AND bid = %d", $form['#parameters'][3], $key);
    }

    drupal_set_message(t('Changes made to the achievement badges'));
    
}
?>

blog terms

Drupal Drupal 6 PHP

Drupal 6: Programmatically Remove Required Field Property from Form

nigel — Sat, 19 Nov 2011 09:12:23 +0000

Drupal 6: Programmatically Remove Required Field Property from Form nigel Sat, 19/11/2011 - 09:12

Suppose you are coding a form in Drupal 6 and you have a mandatory (required) field. However, this required field is only mandatory dependent upon the value in another field. This can happen quite often, and I encountered it at a client site the other day. We had a postcode field that was mandatory only if the country in a selection box was set to 'United Kingdom'. Any other country meant that the postcode field was not required.

So how do we code this? The solution required a little bit of consideration and there are two prongs of attack. Firstly, there is a need to change the validation rule once the form is submitted using the ['#after_build'] index in the $form array. Secondly, we need to do some client side work to hide or show the asterisk which denotes a required field dependent upon what the selection box is showing. This needs a couple lines of Javascript / jQuery.

The Code

remove_required_property.info

name = "Remove Required Property"
description = "Tutorial Code to Programmatically Remove the Required Property of a Form Field"
core = 6.x
php = 5.2
dependencies[] = "location"

Since we are using a drop down selection box with a list of countries we will need to use the location module API.
remove_required_property.module

/**
* Implementation of hook_menu().
*/
function remove_required_property_menu() {

    $items['required-property'] = array(
        'title' => 'Programmatically Remove Required Property From Form Field',
        'page callback' => 'drupal_get_form',
        'page arguments' => array('remove_required_property_form'),
        'access callback' => TRUE,
        'type' => MENU_NORMAL_ITEM,
    );

    return $items;
}




function remove_required_property_form() {

    $form['your-details-postcode'] = array(
        '#type' => 'textfield',
        '#maxlength' => 20,
        '#size' => 20,
        '#title' => t('Postcode'),
        '#required' => TRUE,
        '#attributes' => array('class' => 'donation-your-details-field-text-input'),
    );

    if (module_exists('location') and ($countries = location_get_iso3166_list(FALSE))) 
        $form['your-details-country'] = array(
            '#type' => 'select',
            '#title' => t('Country'),
            '#required' => TRUE,
            '#options' => $countries,
            '#attributes' => array('onChange' => 'postcode_required()'),
            '#default_value' => array('uk' => 'uk'),
        );    
    else 
        watchdog('remove_required_property', t('Unable to load list of countries'), NULL, WATCHDOG_ERROR);

    $form['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Submit'),
    );
        

    $form['#after_build'][] = 'remove_required_property_form_after_build';
    $form['#validate'][] = 'remove_required_property_form_validate';
   
    return $form;
}
?>

There are a few noteworthy comments about this section of the code. I'm loading the countries using the location module location_get_iso3166_list call - obviously if your requirement doesn't need a selection box you can skip this! I have added an '#attributes' index into the $form array to load a call to the JavaScript function postcode_required() which is invoked on every change of the drop down selection box. Finally, there is the aforementioned '#after_build' reference which will check the submitted values and where we can manipulate the validation rules.

function remove_required_property_form_after_build($form, &$form_state) {

    if (isset($form['#post']['your-details-country']) 
        and $form['#post']['your-details-country'] != '' 
        and $form['#post']['your-details-country'] != 'uk')
        $form['your-details-postcode']['#required'] = NULL;

    return $form;
}


function remove_required_property_form_validate($form, &$form_state) {

    // postcode. Required if the country is UK
    if ($form_state['values']['your-details-postcode'] == '' and $form_state['values']['your-details-country'] == 'uk') 
        form_set_error('your-details-postcode', t('You must specify a postcode for addresses within the United Kingdom')); 
}



/**
* Implementation of hook_form_alter().
*/
function remove_required_property_form_alter(&$form, $form_state, $form_id) {

    if ($form_id == 'remove_required_property_form') {
        $mod_path = drupal_get_path('module', 'remove_required_property');
        drupal_add_js("{$mod_path}/js/rrp.js");
        drupal_add_css("{$mod_path}/css/rrp.css");
    }
}
?>

The function remove_required_property_form_alter() is the opportunity to check what has been submitted and if the country is not uk then I don't need the '#required' property so it can be set to NULL. The remove_required_property_form_validate() function is where I do the validation of the postcode - note I'm only checking whether the field is empty or not here. In a live production system something more robust would be required. I use hook_form_alter as an opportunity to load the JavaScript and the CSS.

/**
* Implementation of hook_theme().
*/
function remove_required_property_theme() {

    return array('remove_required_property_form' => array(
            'template' => 'includes/remove_required_property_form',
            'arguments' => array('form' => NULL)));
}
?>

Finally we need a call to hook_theme to set the form to an external template. This will be needed since we are going to have to munge the Drupal generated HTML code.
includes/remove_required_property_form.tpl.php

<table>
<tbody>
    <tr class="rrp-table-padding">
        <td class="rrp-field-text rrp-your-details-leftcell">
            <?php 
                // Postcode
                $output = drupal_render($form['your-details-postcode']);
                if (preg_match("#(.*)(, $output, $match))
                    print str_replace(", "\"rrp-postcode-required\" ", $match[1]);
                error_log($match[1]);
            ?>
        td>
 
        <td>
            <div class="rrp-textfield">
                <?php if (isset($match[2])) print $match[2]; ?>
            div>
        td>
    tr>
 
    <tr class="rrp-table-padding">
        <td class="rrp-field-text rrp-your-details-leftcell">
            <?php 
                // Country
                $output = drupal_render($form['your-details-country']);
                if (preg_match("#(.*)(, $output, $match))
                    print $match[1];  
            ?>
        td>
 
        <td>
            <div class="rrp-select">
                <?php if (isset($match[2])) print $match[2]; ?>
            div>
        td>
    tr>
 
tbody>
table>
<?php print drupal_render($form); ?>

The form's template file presents an opportunity to tabulate the data and make it a little more user friendly. The first requirement is to insert a css tag for the 'required' asterisk. The problem with Drupal 'required' asterisks is they do not have id tags to aid uniqueness so we need to add one with the id of rrp-postcode-required using the PHP str_replace function. Also note I'm calling drupal_render on individual form elements - this marks each one as printed, and then finally I issue another call to drupal_renderwhich will print any form elements not already output - in this case the submit button which falls outside of the HTML table.

js/rrp.js

function postcode_required() {
 
    if (($('#edit-your-details-country').val() == 'uk')) {
        $('#rrp-postcode-required').show();
    } else {
        $('#rrp-postcode-required').hide();
    }
 
}

The very simple JavaScript is called whenever the drop down selection box's value is changed. It will look at the current value, and if it is 'uk' then ensure that the asterisk is displayed, else ensure it is hidden.

css/rrp.css

#rrp-postcode-required {
    visibility: visible;    
}

Some even simpler CSS. The rrp-postcode-required tag is set to initially visible when the form is loaded.

Screen Images

Remove Required Property - UK Selected, Asterisk on Postcode
The second image shows that the asterisk is now hidden because the country has been changed.

Remove Required Property - UK Not Selected, No Asterisk on Postcode

blog terms

Drupal Drupal 6

Drupal 6: Programmatically Create Panels and Nodes in Panels

nigel — Sat, 23 Jul 2011 08:33:10 +0000

Drupal 6: Programmatically Create Panels and Nodes in Panels nigel Sat, 23/07/2011 - 09:33

This tutorial provides the wherewithal to create a new node and insert that node in the top pane on a programmatically created Panel. Looking around the net I was surprised that nobody has done this before. The context for my requirements comes from a not-for-profit client of mine - they wanted to be able to create a new type of charitable donation dependent upon a campaign's remit (this would be the node) and then to place that campaign information (node) in the top pane of the panel. The staff working at the not-for-profit are very talented Drupal-ers and would be able to place supporting static HTML blocks around the node on the panel once they've created the node and the panel.

The inspiration on how to do this comes from analysing the output of the Bulk Exporter utility. To see how this works, create a test panel using your chosen layout and place a test node of type Story on the uppermost pane, go to admin/build/bulkexport, click on the panel you just created, give it a module name, then export. The most significant part of the exported code is the hook_default_page_manager_pages - this does the heavy lifting, creating the handler, page, display and pane classes. So any module we develop in this tutorial will have to implement this hook.

For the Impatient - the Code

donation_campaign.info

name = "Donation Campaign"
description = "Donation Campaign based around Panels"
core = 6.x
php = 5.2
dependencies[] = "panels"
dependencies[] = "page_manager"

donation_campaign.install

/**
* Implementation of hook_install().
*/
function donation_campaign_install() {

    drupal_install_schema('donation_campaign');

}



/**
* Implementation of hook_uninstall().
*/
function donation_campaign_uninstall() {

    drupal_uninstall_schema('donation_campaign');
}



/**
* Implementation of hook_schema().
*/
function donation_campaign_schema() {

    $schema['donation_campaign'] = array(
        'fields' => array(
            'vid' =>            array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
            'nid' =>            array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
            'panel_data' =>     array('type' => 'text', 'not null' => FALSE),
            ),
        'unique keys' => array(
            'nid_vid' =>        array('nid', 'vid'),
            ),
        'indexes' => array(
            'nid' =>            array('nid'),
        ),
        'primary key' => array('vid'),
    );

    return $schema;
}
?>

donation_campaign.module

/**
* Implements hook_node_info().
*/
function donation_campaign_node_info() {

    return array(
        'donation_campaign' => array(
            'name' => t('Donation Campaign'),
            'module' => 'donation_campaign',
            'description' => t("Donation Campaign based on the Panels module technology"),
            'has_title' => TRUE,
            'title_label' => t('Donation Campaign Title'),
            'has_body' => TRUE,
            'body_label' => t('Donation Preamble'),
            ),
        );

}




/**
* Implementation of hook_form().
*/
function donation_campaign_form(&$node) {

    $type = node_get_types('type', $node);

    if ($type->has_title) {
        $form['title'] = array(
        '#type' => 'textfield',
        '#maxlength' => 250,
        '#title' => check_plain($type->title_label),
        '#required' => TRUE,
        '#default_value' => check_plain($node->title),
        '#weight' => -5,
        );
    }

    if ($type->has_body)
        $form['body'] = node_body_field($node, $type->body_label, $type->min_word_count);


    return $form;

}




/**
* Implements hook_perm()
*/
function donation_campaign_perm() {

    return array(
        'create donation_campaign',
        'edit donation_campaign',
        'delete donation_campaign',
        'view donation_campaign',
    );
}



/**
* Implements hook_access()
*/
function donation_campaign_access($op, $node, $account) {

    switch ($op) {
        case 'create':
            return user_access('create donation_campaign', $account);
        case 'update':
            return user_access('edit donation_campaign', $account);
        case 'delete':
            return user_access('delete donation_campaign', $account);
        case 'view':
            return user_access('view donation_campaign', $account);

    }
}



/**
* implements hook_insert().
*/
function donation_campaign_insert($node) {

    db_query(
        'INSERT INTO {donation_campaign} (vid, nid) '
        ."VALUES (%d, %d)",
            $node->vid,
            $node->nid);

    // create the panel if everything looks ok
    if ($node->path and (strpos($node->path, '/') === FALSE)) {

        // now construct and save the panel data
        $page = new stdClass;
        $uscore_title = str_replace(' ', '_', $node->title);
        $page->disabled = FALSE; 
        $page->api_version = 1;
        $page->name = $uscore_title;
        $page->task = 'page';
        $page->admin_title = $node->title;
        $page->admin_description = $node->title;
        $page->path = 'donate/' . $node->path;
        $page->access = array();
        $page->menu = array();
        $page->arguments = array();
        $page->conf = array();
        $page->default_handlers = array();


        $handler = new stdClass;
        $handler->disabled = FALSE; /* Edit this to true to make a default handler disabled initially */
        $handler->api_version = 1;
        $handler->name = 'page_' . $uscore_title . '_panel_context';
        $handler->task = 'page';
        $handler->subtask = $uscore_title;
        $handler->handler = 'panel_context';
        $handler->weight = 0;
        $handler->conf = array(
            'title' => '',
            'no_blocks' => 0,
            'pipeline' => 'standard',
            'css_id' => '',
            'css' => '',
            'contexts' => array(),
            'relationships' => array(),
        );

        $display = new panels_display;
        $display->layout = 'twocol';
        $display->layout_settings = array();
        $display->panel_settings = array(
            'style_settings' => array(
                'default' => NULL,
                'left' => NULL,
                'right' => NULL,
            ),
        );
        $display->cache = array();
        $display->title = '';
        $display->content = array();
        $display->panels = array();

        $pane = new stdClass;
        $pane->pid = 'new-1';
        $pane->panel = 'left';
        $pane->type = 'node';
        $pane->subtype = 'node';
        $pane->shown = TRUE;
        $pane->access = array();
        $pane->configuration = array(
            'nid' => "{$node->nid}",
            'links' => 0,
            'leave_node_title' => 0,
            'identifier' => '',
            'build_mode' => 'full',
            'link_node_title' => 0,
            'override_title' => 0,
            'override_title_text' => '',
        );
        $pane->cache = array();
        $pane->style = array(
            'settings' => NULL,
        );
        $pane->css = array();
        $pane->extras = array();
        $pane->position = 0;

        $display->content['new-1'] = $pane;
        $display->panels['left'][0] = 'new-1';

        $display->hide_title = PANELS_TITLE_FIXED;
        $display->title_pane = 'new-1';
        $handler->conf['display'] = $display;
        $page->default_handlers[$handler->name] = $handler;

        db_query("UPDATE {donation_campaign} SET panel_data = '%s' WHERE vid = %d", serialize($page), $node->vid);

        menu_rebuild();

    }
}



/**
* Implementation of hook_default_page_manager_pages().
*/
function donation_campaign_default_page_manager_pages() {  

    $ret = db_query("SELECT panel_data FROM {donation_campaign} INNER JOIN {node} USING (vid) WHERE `status` = 1");
    while($res = db_fetch_object($ret)) {
        $page = unserialize($res->panel_data);
        $pages[$page->name] = $page;
    }

    return $pages;

}



/**
* implements hook_update().
*/
function donation_campaign_update($node) {

    if ($node->revision)
        donation_campaign_insert($node);
    //else 
    //    db_query("UPDATE {donation_campaign} SET WHERE vid = %d",
    //        $node->vid);

}



/**
* Implementation of hook_ctools_plugin_api().
*/
function donation_campaign_ctools_plugin_api($module, $api) {

    if ($module == 'page_manager' && $api == 'pages_default') 
        return array('version' => 1);
}





/**
* Implements hook_delete().
*/
function donation_campaign_delete($node) {

    db_query('DELETE FROM {donation_campaign} WHERE nid = %d', $node->nid);
}




/**
* This implementation just handles deleting node revisions.
* Implements hook_nodeapi().
*/
function donation_campaign_nodeapi(&$node, $op, $teaser, $page) {

    if ($op == 'delete revision') 
        db_query('DELETE FROM {donation_campaign} WHERE vid = %d', $node->vid);
}





/**
* Implementation of hook_load().
*/
function donation_campaign_load($node) {

    $result = db_query('SELECT * FROM {donation_campaign} WHERE vid = %d', $node->vid);

    return db_fetch_object($result);
}
?>

For the Relaxed - the Explanation

Those who develop Drupal modules which create new content types should be very familiar with the basic layout of the code, and there is little to be gained from a step-by-step analysis of that aspect of the code. Those wishing to find out more should check out Learning Drupal 6 Module Development or Drupal 7 Module Development.

In the installation source code you will note I have created a field panel_data - this will become a holding area for the serialized page class that contains all the panel information. In reality, there would be additional fields in the table for other functionality, but since this is just a proof of concept test, I have omitted this meta data.

Now look at the module file. After we insert the new node into the database we create the panel using the same sequence of class instantiation as we saw from the bulk exporter. This is saved in the field we just discussed. Note that the layout is hard coded in the $display as two columns. If you need to use a different layout, you should create a sample panel the normal way, then export it using bulk exporter, then copy and paste the $display code over what I have here. In addition, you will need to change the $pane->panel value.

Once the panel_data is saved we need to rebuild the menus for what we have to take effect so we issue a menu_rebuild();

We need to implement hook_default_page_manager_pages - but instead of the hard coded data we see in the example from the bulk exporter, we retrieve the page classes from the panel_data field and unserialize, saving in a array to be returned once all the pages have been retrieved.

Finally, hook_update will need to be changed dependent upon your circumstances. You will need to add your own meta information to the commented out database update call.

blog terms

Drupal Drupal 6