phplist forums

Code: Select all

<?php



/* LCsub.php -- remote List Control via HTTP, subscribe function

   First draft by Rich Cowan, 7/26/05

   I haven't used PHP in a while so this will need some debugging
   to get it working.


THE CONCEPT:

You have a PHPlist installation.  You would like to
be able to issue a simple HTTP command to subscribe
or unsubscribe someone from a list.  To do this,
you will need two php files:

LCsub.php -- will subscribe a user
LCunsub.php -- will unsubscribe a user

Below is just the code for LCsub.


USAGE:

(we assuming list #1, master password is "plist")

Command:
http://mydomain.com/lists/LCsub.php?pwd=plist&email=johndoe%40aol.com

Result:
This will subscribe John Doe to the default email list, the list
with an id of 1; note that the '@' sign has been replaced here
by %40 which is needed by most web servers.

Command:
http://mydomain.com/lists/LCsub.php?pwd=plist&email=johndoe%40aol.com&lid=2&first=John&last=Doe&state=TX

Result:
This will subscribe John Doe to email list #2, and also add
user data for him, namely John's first name, last name, and
state, which must be set up as phplist attributes for List #2.
We assume (for now) that John is not an existing user.


INSTALLATION AND CONFIGURATION:

Just copy this script to the home directory of phplist, the lists folder.
To make it executable (on Linux), do a 'chmod 755 phplist'

To configure, just replace the values below for settings with the
location of your phplist installation, and a working admin password
for this installation, the names of your attributes, and finally
the default list ID to modify if the enduser does not supply a list ID.

Questions? Feel free to email me, richcowan <at> gmail.com

*/


// GLOBAL VARIABLES
var $u, $p, $domain, $lid;      // configuration settings
var $pwd, $email, $first, $last, $org, $state;   //http parameters
var $tmp;      // temporary

// CONFIGURATION SETTINGS.  Set them up for your host
$lid = 1;                        //lid is the default PHPlist List ID to use
$domain = "mysite.com/lists"
$u = "admin"
$p = "phplist"   
$attr1 = "first"
$attr2 = "last"
$attr3 = "state"

//THE CODE


// 1) Retrieve the password parameter supplied in http request
$pwd = _GET['pwd'];
if ($pwd == 'masterpassword') {     // make sure password matches

// 2) if script password is correct, then retrieve other parameters
$email = _GET['email'];
$attr1 = _GET['$attr1'];
$attr2 = _GET['$attr2'];
$attr3 = _GET['$attr3'];
$tmp = _GET['lid'];
if ($tmp != "") {$lid = $tmp; }   //user may override default list ID

// 3) Now simulate login to phplist
//    Using a 'get' request, might need to be rewritten as a 'post'
$tmp = fopen("http://www.phplist.com/lists/admin.php?login=$u?password=$p");
echo($tmp);    //debug code, ok to remove

// 4) Now we build the string for subscribing
$tmp = "http://$domain/admin/?action=insert&doadd=yes&id=$lid";
$tmp += "&email=$email;
if ($attr1 != "") { $tmp += "&attribute1=$attr1";
if ($attr2 != "") { $tmp += "&attribute2=$attr2";
if ($attr3 != "") { $tmp += "&attribute3=$attr3";
echo($tmp);    //debug code, ok to remove

// 5) Now we issue the subscribe command!
$tmp = fopen($tmp);
echo($tmp);    //debug code, ok to remove


}  // end of if clause

// close the php tag
?>




Code: Select all

<?php

/* LCsub.php -- remote List Control via HTTP, subscribe function

   Second draft by Rich Cowan, 8/8/05

   This is much closer...


THE CONCEPT:

You have a PHPlist installation.  You would like to
be able to issue a simple HTTP command to subscribe
or unsubscribe someone from a list.  To do this,
you will need two php files:

LCsub.php -- will subscribe a user
LCunsub.php -- will unsubscribe a user

Below is just the code for LCsub.


USAGE:

(we assuming list #1, master password is "plist")

Command:
http://mydomain.com/lists/LCsub.php?pwd=plist&email=johndoe%40aol.com

Result:
This will subscribe John Doe to the email list; note that the
'@' sign has been replaced here by %40 which is needed by most
web servers.

Command:
http://mydomain.com/lists/LCsub.php?pwd=plist&email=johndoe@aol.com&first=John&last=Doe&state=TX

Result:
This will subscribe John Doe to the email list, but also add
user data for him, namely John's first name, last name, and
state, which must be set up as phplist attributes for List #2


INSTALLATION AND CONFIGURATION:

Just copy this script to the home directory of phplist, the lists folder.
To make it executable (on Linux), do a 'chmod 755 phplist'

To configure, just replace the values below for settings with the
location of your phplist installation, and a working admin password
for this installation.

Questions? Feel free to email me, richcowan <at> gmail.com

*/


// GLOBAL VARIABLES

// CONFIGURATION SETTINGS.  Set them up for your host
$domain = "mysite.org/lists";
$u = "admin";
$p = "phplist";
$lid = 1;                        //lid is the default PHPlist List ID to use
$masterpassword = "mymasterpassword";

// Attribute names that we are using
$attr1 = "first";
$attr2 = "last";
$attr3 = "state";

//THE CODE

// 1) Retrieve the password parameter supplied in http request
$pwd = $_GET['pwd'];

if ($pwd == $masterpassword) {     // make sure password matches
echo("Master Password was correct.<br>");    //debug code, ok to remove

// 2) if script password is correct, then retrieve other parameters
$email = $_GET['email'];
$attval1 = $_GET['$attr1'];
$attval2 = $_GET['$attr2'];
$attval3 = $_GET['$attr3'];
$tmp = $_GET['lid'];
if ($tmp != '') {$lid = $tmp; }   //user may override default list ID
if ($email == '') {
   echo('You must supply an email address');
    return(0);
}

// 3) Now simulate login to phplist
//    Using a 'get' request; this seems to work using CURL
$httpstring = "http://$domain/admin/?login=$u&password=$p";
$curl = curl_init($httpstring);
echo("login URL was: $httpstring<br>");    //debug code, ok to remove
curl_setopt($curl, CURLOPT_URL, '$httpstring');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$tmp = curl_exec($curl);
echo("result was: $tmp<br>");    //debug code, ok to remove


// 4) Now we build the string for subscribing
//$httpstring = "http://$domain/admin/?page=members&login=$u&password=$p&name=$email&listid=$lid";
//$httpstring = "http://$domain/admin/?page=user&id=0&confirmed=1&subscribe[]=1&subscribe[]=2&email=$email";
$httpstring = "http://$domain/admin/?page=user&id=0&confirmed=1&subscribe%5B%5D=1&subscribe%5B%5D=2&email=$email";

//optionally add attributes avlues
if ($attval1 != '') $httpstring .= "attr1=$attval1";
if ($attval2 != '')  $httpstring .= "attr2=$attval2";
if ($attval3 != '')  $httpstring .= "attr3=$attval3";
echo("action URL is: $httpstring<br>");    //debug code, ok to remove

// 5) Now we issue the subscribe command!
curl_setopt($curl, CURLOPT_URL, $httpstring);    // we are still logged in, we do not reinit
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
// might also went to set CURL to use HTTP post
// but this is not working because we have to set the cookie for PHPsessionid
$tmp = curl_exec($curl);
echo("result was: $tmp<br>");    //debug code, ok to remove

//6) Clean up
curl_close($curl);

}  // end of if clause

else {
echo("Password not supplied.");
}

// close the php tag
?>



octech wrote:hi Michiel --
I would be happy to do some more work on this code... however it kind of makes sense to check in with you first. In the meantime I am busy working on the next release of OrganizersDB (www.organizersdb.org) which I hope to integrate with PHPlist.

Also... are you thinking of attending the first UK conference of nonprofit technology "circuit riders" which I believe is in November in London?

My questions:

a) in the 2.10.x releases, are there any changes I should know about?

b) what are you future plans for modularization of the code?

c) would it be possible for you to add dates to the releases in your web site? It is kind of wierd looking at release notes or download links that have no mention of the date of release.

Code: Select all

<?php

/* LCsub.php --

Purpose: Remote List Control via HTTP, subscribe function
Original Author: Rich Cowan, 8/8/05
Modified by: Jesse Heap 1/1/2006

Details:
With PHPList installed this procedure can be use to
subscribe a user using the HTTP command.  The procedure works
by simulating a POST to the default subscribe page.  It requires
the CURL PHP library.

LCsub.php -- will subscribe a user

USAGE:

(we assuming list #1, master password is "plist")

Command:
http://mydomain.com/lists/LCsub.php?pwd=plist&email=johndoe%40aol.com

Result:
This will subscribe John Doe to the email list; note that the
'@' sign has been replaced here by %40 which is needed by most
web servers.

Command:
http://mydomain.com/lists/LCsub.php?pwd=plist&email=johndoe@aol.com&attribute1=John&attribute2=Doe&attribute3=TX

Result:
This will subscribe John Doe to the email list, but also add
user data for him, namely John's first name, last name, and
state, which must be set up as phplist attributes for List #2


INSTALLATION AND CONFIGURATION:

Just copy this script to the home directory of phplist, the lists folder.
To make it executable (on Linux), do a 'chmod 755 phplist'

To configure, just replace the values below for settings with the
location of your phplist installation, and a working admin password
for this installation.

Questions? Feel free to email me, richcowan <at> gmail.com

*/


// GLOBAL VARIABLES

// CONFIGURATION SETTINGS.  Set them up for your host
$domain = "http://www.yourdomain.com/lists/";
$lid = 1;                        //lid is the default PHPlist List ID to use
$masterpassword = "YourPassword";    //Master password prevents unauthorized calls to script

// CODE

// 1) Retrieve the password parameter supplied in http request
$pwd = $_GET['pwd'];

if ($pwd == $masterpassword) {     // make sure password matches
echo("Master Password was correct.<br>");    //debug code, ok to remove

// 2) if script password is correct, then retrieve other parameters
   $ary = explode('&', $_SERVER['QUERY_STRING']);
   $i = 0;
      $post_data = array();
   while ($i < count($ary)) {
      $getArray = split('=', $ary[$i]);   
       // Set each GET value pair to the post_data associative array in preparation for the POST
      if (strcasecmp(urldecode($getArray[0]),'pwd')!=0) { // Ignore PWD parameter - not needed for POST
         $post_data[urldecode($getArray[0])] = urldecode($getArray[1]);
      }
      $i++;
   }
// Set email
$email = $post_data['email'];
$tmp = $_GET['lid'];
if ($tmp != '') {$lid = $tmp; }   //user may override default list ID
if ($email == '') {
   echo('You must supply an email address');
    return(0);
}
// Add additional post data required by form
   $post_data["emailconfirm"] = $email;
   $post_data["htmlemail"] = "1";
   $post_data["list[$lid]"] = "signup";
   $post_data["listname[$lid]"] = "test";
   $post_data["subscribe"] = "Subscribe";
   $url = $domain . "?p=subscribe";

   $ch = curl_init();
   curl_setopt($ch, CURLOPT_POST, 1);
   curl_setopt($ch, CURLOPT_HEADER, 0);
   curl_setopt($ch, CURLOPT_URL, $url);   
   curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
   curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
   $result = curl_exec($ch);
   //echo("Result was: $result<br>");
//6) Clean up
curl_close($ch);

}  // end of if clause

else {
echo("Password not supplied.");
}

// close the php tag
?>