New to the Pictures Section
This is kind of a two-part post. The first is to just let everyone know that I've finally uploaded pictures of the Portland wedding that my Uncle Steve took. If you were at the wedding, there's a good chance you'll find yourself in one and if you weren't, check it out to see what you missed!
If you've ever used the commenting option at the bottom of each picture, you'll also notice a few new features. I'm sure you know how frustrating it is when you don't enter your name and it inserts "Some anonymous shmoe" as a replacement. My first new feature alleviates that problem to a large extent. Now the first time you enter a comment on a computer, it will remember your name and if you forget to enter your name in a future comment, it will insert the name you used in your last comment. It won't follow you around from computer to computer (that would be impossible) but it will work on any computer you use as long as you don't clear your cookies.
If you like to comment on photos you probably know the feeling you get when you accidentally hit the Enter button after leaving half a comment, or the feeling you get when you leave comments after heavily drinking the night before and wake up to find yourself the laughing stock of the community (the cameronhinkle.com community, that is. ....so basically, me). At your rescue is the new "delete" button. It's in the form of a red X and it will appear at the end of all your future comments. Again, it only works per-computer and will be there as long as you don't clear your cookies. If you don't know what "clear your cookies" means, you'll have some catching up to do. I would start here.
For those of you who care, I'll get a little into the specifics of how I made these possible. The first is easy, I just set a cookie in your browser that contains the name you enter for each comment, then I check for it if you don't enter a name in the future. The delete button is a little tougher. Cameronhinkle.com now keeps a cookie in your browser that holds a pipe-delimited list of comments that you've made. Every time you enter a new comment, it adds the comment id to the cookie. Then whenever you view a picture on CameronHinkle.com, it explodes the list of comment ids into an array and iterates through each comment id to see if it exists in the array of comments that have been submitted for that photo. If a comment is found in the array, it puts the red X inside a form at the end of that comment with the comment id as a hidden field. When the X is clicked, the form posts the comment id to the server and the comment is deleted using my versatile and robust Picasa API. The way that it is deleted is similar to the way it's posted, which you can read about in my article Comments: Enabled. I haven't worked out all the kinks (in fact it just blew up on me a second ago) but it's coming along nicely and I think it will be a really useful addition.
This deleting mechanism obviously opens up a bit of a security risk. All someone would have to do is post a comment id to the page to delete any comment they want. I'm not too concerned about this because I don't know who would care about deleting comments. Also, it would be a little bit of a hassle to find the comment id for a particular comment, especially if you don't know anything about the Picasa API. If I put the X next to every single comment I could definitely see someone clicking all the X's just to be annoying, but it's probably inconvenient enough as it is that no one will bother. If I'm wrong and there is an incident, I'll just encrypt the ids before I store them in the cookie. I would do that now but I wanted to make the page load as fast as possible.
Hopefully this and the Comments: Enabled post has given some people a few creative ideas of what is possible with the API. I've gotten a lot of good feedback on the Pictures section in general and am always trying to come up with ways to improve it. Of course if you don't use it then all my work is in vain, so go comment find your favorite picture and make some comments!
Picasa API Update
I've been pretty lax in getting an update to the Picasa API available for download. I've got a bit more going on than usual, and everyone can probably expect this level of commitment through the NBA Playoffs :) However I did finally manage to get back in and write some code. The outcome is Version 3.1 of the Picasa API, which you can download here. All the other download links on the site are up to date as well. This update fixes the following problem:
- No thumbnail size option in Picasa::getImageById() (Issue 2)
- Updated documentation for the Picasa_Author class (Undocumented)
- Fixed Picasa::getContactsByUsername(), which did not previously support authenticated feeds (Undocumented)
Comments
Glad you like it! Well officially I have not stopped development. However, life has been particularly bigger this summer with two weddings and a honeymoon so I haven't had much time at all to work on the API. I do fully intend on putting out an update in October and I'll be sure to make a post the minute I do
Oh and to the other comment, if you'd like an example the best post to look at is http://cameronhinkle.com/blog/id/7309305433109234799.
Great Picasa Class!!. I'll use it in my site.
Are you going to improve this code or you have stopped its development?
Good Luck!!
Hi,
your Picasa API is very nice. Can you give me some example files for better understanding, please. That would be very nice.
Sorry for my bad English. I am from Germany and English isn't my language.
Thanks
Rainer
Building Your Own Picasa Gallery
Since the release of version 3 of my Picasa API I've received some feedback from users that it would be helpful to have some sample code for those who want to do the basics: host their own gallery. I can relate with this, since it's the reason I built the API in the first place. Sure, you can do a lot of other cool stuff with the API, like uploading and managing photos, but certainly the typical adopter is just going to want their own Picasa pictures viewable from their personal homepage. So here is a quick rundown of how to do a basic gallery using the Lightweight PHP Picasa API, version 3.0.
As you might already know, my gallery consists of three types of pages, which I will refer to as an account page (seen here), an album page (for instance, here), and an image page (for instance, over here). It's pretty self explanatory, the account page lists all the albums, the album page lists all the photos in an album, the image page shows a larger version of the selected image. For each page type, you'll need some kind of information that you can store in a constant or get from GET/POST data. I'll go over each page type and list source code along with what information is required.
Account Page
For the account page, the only thing you'll need is the username. I recommend storing the username in a constant variable somewhere where all your code can access. This is so that if your username changes, or you want to give your code to someone else, you only have to change the username in one place. I store mine in a variable called "Cam_Util_PictureUtil::$USERNAME". However, for the sake of readability, I'll just refer to it in the following code as "$username". Here's the code for the account page, which just outputs each album's icon with a link to the album page. I use a URL structure similar to what my site uses, but modified to be closer to the typical setup. And obviously you can change the HTML to suit your needs:
$pic = new Picasa();
$account = $pic->getAlbumsByUsername($username);
$albums = $account->getAlbums();
foreach ($albums as $album) {
print('<a href="http://www.your_web_site.com/album.php?
albumid='.$album->getIdnum().'">
<img src="'.$album->getIcon().'" />');
print('<div>'.$album->getTitle().'</div>');
}
Album Page
For the album page, you'll not only need the username, but you'll also need the album id. If you use the URL structure used in the previous example, you should be able to get the album id from the $_GET superglobal. I'll include how to do that in the code sample. So the album page just prints each image in the album with a link to the Image Page and the album title displayed below:
$albumid = $_GET["albumid"];
$pic = new Picasa();
$album = $pic->getAlbumById($username, $albumid);
$images = $album->getImages();
foreach ($images as $image) {
print('<a href="http://www.your_web_site.com/image.php?
albumid='.$albumid.'&imageid='.$image->getIdnum().'">
<img src="'.$image->getMediumThumb().'"/>');
print('<div>'.$image->getTitle().'</div>');
}
Image Page
Lastly for the image page, as you might have guessed, you'll need the username, album id, and image id. Again, using the above example, you get the image id from the $_GET superglobal. The image page prints the image, the image title, and the description of the image:
$albumid = $_GET["albumid"];
$imageid = $_GET["imageid"];
$pic = new Picasa();
$image = $pic->getImageById($username,$albumid, $imageid);
print ('<img src="$image->getLargeThumb().'" />');
print('<div>'.$image->getTitle());
print('<div>'.$image->getDescription().'</div></div>');
Unfortunately the current implementation of Picasa::getImageById() doesn't support any image sizes other than the defaults (which are pretty small). This was an oversight on my part because there was a workaround that made it not necessary. Unfortunately, due to a change in Google's API, the workaround no longer actually works. I've emailed the Picasa development mailing list to find out if there is another workaround that will work now, but I've also entered an enhancement request in my project's Google Code page. As soon as I fulfill that request, I'll post a quick tutorial on how to get larger sized images. It should be less than a week for that to happen.
Hopefully this tutorial has been helpful. Thanks to everyone who has given me feedback on the API, so far I've only heard good things. If something's not quite working right or it seems there's something wrong with the tutorial here, please let me know. And check back in the next week, I should have the fix for getting larger image sizes available for download, and I'll include a bit of code on displaying and posting comments for your images.
Comments
Sorted! Just wanted to let you know to save the trouble of posting a reply...
For anyone else who's wondering, you can set the include path as follows:
ini_set('include_path',ini_get('include_path').'.:/home/path/to/picasa/apifolder/');
I talked to my hosting company, and they said fopen is off-- which I figure is probably the cause of this and other similar scripts not working for me.
They said I can use curl.
Hi there
Really excited about using your api, but I just can't get it to work. I'm having the same problem as anonymous - i.e. the paths aren't working. I'm on a shared host so can't place the api within the include path (afaik) - I've tried using ini_set at the top of my page, but that's not working either - can you help?
While I'm here - thanks for your hard work on all this - just hope I can get it working at some point!
No problem, Pat, it happens to the best of us. And again, I'm available via email if you still want to try to get it to work.
I was obviously out of line with that comment-- and I apologize.
Hmm, I'm not sure what you're doing wrong, I haven't heard of other people having problems like that. If you want me to try to figure out where you're making mistakes, I'm pretty responsive via email.
Sorry you're getting so worked up, I can sense the frustration in your tone. But that's part of being a programmer I guess. Reminds me of a comic I saw on a coworker's wall. Haven't we all been there?
I thought this was going to be a simple and easy solution to what I wanted to do: Display my picasa galleries on my page.
But I get nothing but errors. After spending an hour fixing your include paths(you have paths to files in different directories without the directory included in the path, and paths to files in the same directory pointing to different directories).. I thought OK now it will work.. include paths are different for everyone.
Nope.
I used your code from this page and got nothing but fatal errors. Not sure why. I can't post the code on here to show you either.
Probably should have left it with the simple version-- which I wanted to download but you changed the link for that one to this bloated and broken version.
Great work! I have been looking for this for a very long time!
It works great for me, your gallery example. The only thing is the small size if the pictures. Just letting you know that I love to hear a solution!
Yes, I did look into this with the Picasa mailing list. It is Picasa's policy to only allow embedded images of 800px and less. So to get a larger version of an image you would call Picasa::getImageById() and pass in a valid pixel size for either imgmax or thumbsize. Valid values are, according to the Picasa documentation:
200, 288, 320, 400, 512, 576, 640, 720, 800
For me, this is large enough. If you need a larger version you can still get it, but you won't be able to embed it in your page, you can only have the user explicitly download it to their hard drive and open it. Valid values for that are:
912, 1024, 1152, 1280, 1440, 1600
If you notice on Picasaweb, they follow the same rules. The main image is 720px and I believe the download version is 1600px. Keep in mind that these values represent the longest side of the image, not the top or side. I could update my Pictures section to use larger images but I think the default size is fine for a preview; users can click on the image for a larger one displayed via LightBox.
Unfortunately using thumbnails can be a bit of a hassle with my API (Issue 4 in the issue list). I think the current implementation was born from a 3am coding session. I'm probably going to undeprecate the fields that I previously deprecated to put in place the current system, and I'll add a new way for retrieving them. I'm not sure when I'll have time to do this, particularly with me getting married in 2 months, but I'm pretty confident I'll get back to working on the API soon. I've been working in Eclipse since starting at Nike and am looking forward to some Vim time.
hey,
is there anyway to see the normal size image that i would see via google's picasaweb interface? i read that you contacted google about that; just curious if any response since april? it's kind of small the current one :)
thanks,
matthew
Lightweight PHP Picasa API Version 3.0
After weeks and weeks of toiling away at my desk in my free time, I've finally put the finishing touches on Version 3.0 of my Lightweight PHP Picasa API. I think the extra time has not been wasted, as this version is about a thousand times more robust and feature-rich than versions 1 and 2, as well as being a lot easier to use. For easy access, here are the important links:
Download the API source code
View the Documentation
View the bug and feature request list
Here I'll list the major features, and then go into greater detail on each one. Features include:
- Automatic query building through the Picasa class
- Pass in the parameters for your request and the member functions will build and send the query for you.
- Robust error handling through the Picasa_Exception class
- 8 different Exception classes that can be caught individually, all of which extend Picasa_Exception to allow any level of granularity your situation requires.
- Easy-to-use implementation of authorizations through the Picasa class
- Supports Client Login or AuthSub
- Supports persistent authorizations using browser cookies
- Added previously unsupported operations
- Suports not only fetching feeds, but also posting and deleting images, albums, comments, and tags, as well as updating images and albums.
- Include access to public and private albums.
- Added several fields to existing classes
- Added support for Exif data, GML coordinates, among others
- Comprehensive documentation using PHPDoc
- View the Javadoc style manual here.
- 100% backwards compatible with versions 1 and 2
- It's still "lightweight"
- No special requirements, just PHP 5
- Less than a third the size of the Zend framework
The Picasa class is certainly the biggest addition to the new version. It's really the only object that your client code will ever have to instantiate. It handles both authorization as well as data requests and manipulations (posting and updating images, etc). The nice part about how it handles data requests is that you'll literally never have to formulate a query string again. Pretty much any type of feed that can be requested from Picasa is supported through just a few different methods in this class. Just instantiate a Picasa object and then call the method you're looking for. For instance, to get all albums for user "goldplateddiapers" (that's me), use the following code:
Now $albums will hold a Picasa_Account object that has an array of all my albums. To see exactly what is in a Picasa_Album, you can look at the manual, or you can just print the object. I've added very handy __toString() methods for all the objects. So add this line and see what you get:$pic = new Picasa();
$albums = $pic->getAlbumsByUsername("goldplateddiapers");
If you're viewing this in Firefox (which you should be!), view the page source to get a prettier display. The output should be a nicely formatted printout of every field in the object. Each one of those fields has a getter method so that you can access the data you see.print $albums;
Of course, oftentimes your request will not be as simple as getting all images from one user. So each of the "get" functions in the Picasa class take a plethora of parameters to suit your needs. For instance, take a look at the definition for Picasa::getImages():
public function getImages($username=null, $maxResults=null,
$startIndex=null, $keywords=null, $tags=null,
$visibility="public", $thumbsize=null, $imgmax=null);
As you can see, none of these parameters are required. Which ones you should supply depend on what you're looking for. To find the first 250 images in Picasa tagged "lolcats", do the following:
Now $images will be a Picasa_ImageCollection object with an array of up to 250 of your favorite lols. The same format follows for any methods in the API starting with "get". And of course, all of the parameters for each method are fully described in the documentation.$pic = new Picasa();
$images = $pic->getImages(null, 250, null, null, "lolcats");
One thing to be careful of is that all combinations are not supported by Picasa. For instance, calling just Picasa::getImages() with no parameters, Picasa itself will probably yield an error, which will be thrown as a Picasa_Exception with the error message retrieveable through Picasa_Exception::getMessage(). See the next section for more information on exception handling. I've left it up to the client code to send acceptable requests; the API will only throw an exception if Picasa itself responds with an error, the API doesn't catch invalid combinations of parameters and thus they're not documented here. You'll have to play around with different parameter combinations or check Picasa's Developer Guide.
Robust error handling through the Picasa_Exception class
The previous versions of the API didn't do much in the way of error handling, and this aspect is probably the second biggest improvement since then. There is one main exception class, called Picasa_Exception, that all exceptions thrown from the API will be at least subclassed from. It's not an abstract class, so oftentimes an instance of Picasa_Exception itself will be thrown, but a more specific subclass will be thrown when appropriate. Take a look at the subclasses in the documentation or the source code, they're all listed in the Picasa_Exception class.
To give you some background on how the API knows it should throw an exception when it's given a bad request (skip this paragraph if you don't care), basically the method that is used for executing requests (Picasa::do_request()) checks for a response of 200 or 201. If that's not found, it passes the response header to a method (Picasa::getExceptionFromInvalidPost()) that determines which kind of exception to throw. It saves the error message given by Picasa as the result of Exception->getMessage(). However, sometimes the body of the response, even if it was not a 200 or 201 response code, can be useful. For example, if a client is trying to authenticate using Client Login and Picasa requests a CAPTCHA challenge, the response code is 403, but fields are set in the body identifying the URL to the CAPTCHA challenge and the CAPTCHA's token value. The API uses the Picasa_Exception::getResponse() method to get the returned response, determine that it is a CAPTCHA challenge, and parse out the required fields.
The only other exception class in the API that adds any fields to the base Exception class is Picasa_Exception_CaptchaRequiredException. This (as you might have guessed) is thrown when a CAPTCHA challenge is requested by Picasa upon attempting to gain authorization. If you're unfamiliar with this operation, Picasa will ocassionally require a user attempting to login using Client Login to type in letters that appear in a supplied image in order to guarantee that the user is a real person. To login after a CAPTCHA is requested, you do exactly what you did to log in the first time, this time passing in the user's CAPTCHA answer and a token supplied by Picasa (see the next section for how the API deals with logins and CAPTCHAs). The Picasa_Exception_CaptchaRequiredException contains the method Picasa_Exception_CaptchaRequiredException::getCaptchaUrl() for getting the URL to the image to display, the method Picasa_Exception_CaptchaRequiredException::getCaptchaToken() for getting the token to pass along with the re-attempt at authorization, and the methods Picasa_Exception_CaptchaRequiredException::getUsername() and Picasa_Exception_CaptchaRequiredException::getPassword() for getting the user's username and password that they originally used when attempting to sign in.
As an example of how to use the Picasa_Exception classes effectively, here is an example of client code attempting to log in (see the next section for details about how to use the authorization functionality, but I think you can infer what the code is generally doing). Let's assume I've just requested the user's username and password in a form, using the POST method:
Easy-to-use implementation of authorizations through the Picasa class// Get the username and password from the POST superglobal
$user = $_POST['username'];
$password = $_POST['password'];
$pic = new Picasa();
try{
$pic->authorizeWithClientLogin($user, $password);
} catch (Picasa_Exception_CaptchaRequiredException $ce) {
print "Please enter the letters you see in the image: ";
print '<img src="'.$ce->getCaptchaUrl().'" />';
/* Put code for generating a form with an input field, setting $ce->getCaptchaToken(),
* $ce->getUsername(), and $cd->getPassword() as hidden fields here
*/
} catch (Picasa_Exception_InvalidUsernameOrPasswordException $ie) {
print "The username or password you have entered is invalid.";
/* Put code for handling re-logins here
*/
} catch (Picasa_Exception $e) {
print "Your attempt to login has failed: ".$e->getMessage();
/* Put code for handling relogins here
*/
}
Previous implementations of the Lightweight PHP Picasa API did not support authorizations in any way. This suited my needs personally, but left a lot of people out of luck or on their own to throw something together. With the addition of the Picasa class, though, comes a suite of methods and fields for gaining and keeping authorizations. The first thing you need to know about is the difference between Client Login and AuthSub. Client Login allows you to enter a user's username and password, while AuthSub requires your client to redirect the user to a Google-hosted secure page to enter their username and password. The Picasa class supports both.
To authorize a user using Client Login:
- Get their username and password
- Call Picasa::authorizeWithClientLogin(), passing in their username and password.
To authorize a user using AuthSub:
- Redirect the user to the Google login page using Picasa::redirectToLoginPage()
- On the page supplied in the $next parameter or Picasa::redirectToLoginPage(), call Picasa::authorizeWithAuthSub().
A neat feature that is built into the API is persistent login through the use of cookies. Cookies are used because there's no server-side caching mechanism supplied with the API. So by default, if you authorize a Picasa object, it will store the authorization token and the type of authorization used (AuthSub or Client Login) in the users browser cookies. Tokens don't expire for quite a while, so this allows the user to login once and remain logged in as long as you like. You can use the method Picasa::authorizeFromCookie() and it will automatically look in the user's cookies for an authorization token and authorize the object if it finds one. If it doesn't, false is returned and your client code can prompt the user to login again. So here is a snippet for logging in using AuthSub:
$pic = new Picasa();
if ($pic->authorizeFromCookie() === false) {
Picasa::redirectToLoginPage("http://yourdomain.com/samplePage.php");
}
//Perform authorized requests here
On the other hand, if you don't want the API to automatically save the token to the user's cookie and you want to save it yourself in a more secure way, you can pass false as the $saveAuthorizationToCookie parameter of either Picasa::authorizeWithAuthSub() or Picasa::authorizeWithClientLogin(). The token is returned from both methods when a successful authorization is established. To then authenticate a Picasa instance, you can either pass the token along with the type of authorization (represented by the public static members Picasa::$AUTH_TYPE_AUTH_SUB and Picasa::$AUTH_TYPE_CLIENT_LOGIN) into Picasa's constructor when you instantiate it, or call Picasa::setAuthorizationInfo(), also passing in the token and type.
It should also be noted here that Picasa actually returns a "single use token", which is only good for one request, when a user attempts to login through AuthSub. However, the API automatically converts the single use token into a session token and saves that value. There is no parameter to turn that feature off because there is no downside to doing it and a single use token is too worthless to warrant another parameter.
Added previously unsupported operations
Now that authorizations are possible, so are authorized operations. I've done my best to provide pretty much any operation available through Picasa's core Data API in this PHP version. So you can post, update, or delete albums and images from an account that you have permission to do so in once you have have an authorized Picasa instance. You can also post or delete comments and tags, and retrieve private feeds.
The methods for posting, updating, and deleting are extremely similar to the methods for retrieving feeds. There are several "posting" methods, just like there are several "getter" methods described in the first section. So let's say you want to post an album titled "Dwight Schrute's One Night Stand" to the account "goldplateddiapers":
Yeah, I know, the parameter list gets a little ridiculous. However, I've tried to order them in such a way that they will be as short as possible. For instance, had I wanted that album to be public and allow commenting, I could have left off the last two parameters.$pic = new Picasa($token, Picasa::$AUTH_TYPE_AUTH_SUB);
if ($pic->isAuthenticated()) {
try {
$album = $pic->postAlbum("goldplateddiapers", //Username
"Dwight Schrute's One Night Stand", //Title
"Dwight and Angela exchange cat pictures.", //Summary
"private", //Access rights
"false" //Commenting enabled
);
} catch (Picasa_Exception_UnauthorizedException $ue) {
print ("You are not authorized to add this album.");
} catch (Picasa_Exception $e) {
print ("An error occured while posting the album: ".$e->getMessage());
}
} else {
Picasa::redirectToLoginPage("http://yourdomain.com/samplePage.php");
}
Now that you know how to post an album, posting images, comments, and tags are all done the exact same way, though the parameter list varies. You can also update albums and images, although Picasa doesn't allow comments or tags to be updated. Deleting is allowed for all four types of objects. Read the documentation to see exactly which parameters are accepted for each type.
Added several fields to existing classes
There is a cool new feature for some of the getter fields, too, that alleviates some of the problem associated with the null fields. You'll notice in the past that if you request all albums for a single username, the result would have come in the form of a Picasa_Account, which would have an array of Picasa_Album objects. However, those albums would not contain any images, presumably because it would take a lot of extra time to fetch and transfer the information about each image. Now, however, the method Picasa_Album::getImages() will check to see if the $images array is null and fetch a new instance of the current image, pull out the $images array from that instance, and return it. This way, if you want the value, it will always be there. The same logic follows for Picasa_Image::getComments() and Picasa_Image::getTags().
Comprehensive documentation using PHPDoc
I've gone to great lengths to document the entire API, and I finally went through the trouble of generating the docs and hosting them. I think the documentation will be really helpful in using this API, I have literally spent hours preparing it. One thing to note is that it's split up into two packages: Picasa and Picasa_Exception; the latter can be difficult to spot from the documentation's front page, there's a link to it at the very top. You can find all the documentation here.
I did not generate documentation for the Cam folder because it is not really part of the API and shouldn't be used. I attempted to change the code inside those files to utilize the new Picasa class, but the method names and intentions didn't really make sense in the context of the new version. They're still there, for backwards compatibility sake, and they work. However, if you're a newcomer, I would certainly ignore them.
100% backwards compatible with versions 1 and 2
As with the previous versions, drop the code in where your previous code was and you should have no problem. The one caveat is that you have to have had the classes inside the Picasa folder that was provided with the old versions. That folder is no longer the topmost level, the php folder is, so be careful when doing this. And as I stated earlier, the Cam folder is included for backwards compatibility.
It's still "lightweight"
It really depends on what you call "lightweight", but I think I've held true. The main thing is that there are no special packages needed with PHP in order for it to work. It was tempting to use the cUrl library or the Http classes, but I just implemented all the HTTP responses and requests myself.
Also, it's still a very easy install. You should be able to drop the files into your include path and pretty much be ready to go right away. A lengthier explanation is given in the README, but there's not a whole lot to it other than that.
The future
I made this with the intent of making it easy for PHP developers to harness the Picasa service and create really cool new products, so please do so. As always, if you have any commentary, please leave a comment here or send me an email to tell me what you think. I would love to hear that someone really likes or really dislikes anything about the API. If you have features you'd like to see, feel free to let me know or add it to the issue list. And just in case you missed it at the top:
Click here to download the API
Thanks to everyone who has helped with this and everyone who is using it. Now while the bug list is still at zero and my eyes are still open, I'm going to play my Wii...
Comments
Cameron,
Great job on the API. It is very useful and very easy to understand given the great documentation. All I wanted was to display my images from picasa on my website and your library made that easy. BTW thanks so much for the quick E-mail response, all my issues are fixed now!
Brian
brianfietsam.com
Oh! My best wishes and thank you again for taking the time to write this handy library :)
That's great, thank you! I will get that into the next version when its available for download. I've worked on it a little but unfortunately my pending nuptials have left me with absolutely no time to do anything but wedding plan (as anyone who has looked at my blog in the last two months can tell). :-/ After I get back into the normal swing of things I'll get a new version out, though. Hopefully sometime in October.
Hi there Cameron,
I was using your library (which is really useful by the way) and I found a problem.
I've already posted this in google code with a patch.
Cheers
Anonymous comments is something that I would really like to see as well. My workaround is pretty inventive, I think. I wrote all about it in my Comments:Enabled post. I don't think it's appropriate to add directly into the API, but using the API to implement this idea is pretty easy.
On the other hand, maybe it would be a good idea. Writing my own API is really useless unless it offers something that the "official" API doesn't (which is why the next version will have things like methods to copy an image to another album). So maybe anonymous comments wouldn't be bad to have there. I just wouldn't want Google to get after me for potentially compromising the integrity of their comments.
Hope that helps.
Hi,
One thing that Google hasn't implemented yet (I guess) is the support for changing the name on a comment.
I would like to create a photo gallery where the users are able to place comments, either by entering a name or logging in to my site.
Then I would like to add a comment for them, using my own credentials, and specifying the comment authors name.
I guess this is at one hand a stupid thing to add, because you couldn't trust the name of the author anymore. However, in my case, it is stupid that you cannot alter the name.
Do you have any ideas about this, because I checked it out and your API doesn't support giving an author name either.
Greetings,
Tim
PS: Check out the current version of the photo gallery on my site (I'm sorry, but it's in Dutch.)
I am sorry, I didn't search enough :P
Thank you, this is a great work !
John
Hi John. I think I've already posted what you're looking for in this article. Please let me know if there is anything you have questions on that is not covered there.
Hi Cameron,
first of all, thank you for this great work ! :)
My knowledge of php is limited, and I have problems to use your script ! :S
Could you give us some examples of scripts, like displaying albums lists, or pictures form an album ?
Thank you very much !
John
thnx for your help it worked.
the problem was, the line that u said and some path problems, its working now =).
Thanks for your quick answer.
later
Julio
Hi Julio,
Good question. I think the answer is probably that you only moved the contents of the Picasa folder into your path, whereas Picasa.php is actually in the parent folder, called "php". You should copy all contents of the php folder into your include path.
The other problem could be that you did not include Picasa.php in the page. To do that, put the following line at the top of the php file that is using Picasa:
require_once 'Picasa.php';
If you have followed both of those steps and you're still not able to use the Picasa class, then the files are probably still in the wrong path.
Hope that helps!
hi cameron, just giving a try to this , it looks like pretty interesting,
now i feel a bit ignorant , cuz i cant install the package ...
that include thing,
quoting the readme:
"To install this software, simply place it within your include path.
You can set your include path by calling ini_set('include_path', '/PATH/')."
Reading that, i make the next steps:
* cheking what was de path.
* coping your picasa dir, on it.
then , i get the next error message:
"Fatal error: Class 'Picasa' not found in C:\bla bla\servers\bla bla\htdocs\index2.php on line 4
"
Where line 4 is:
"$pic = new Picasa();"
so i suppouse that the problem comes from the include path thing...
Is there some php variable that i have active or deactivated to have that thing going on ?
for example , calling the "phpinfo();"
i realize that i have
"allow_url_include Off Off"
well thats enough for now ...
i think you'll see why i feel pretty ignorant u_u.
sorry ir my english isn't the best , but , i speak spanish =p
Forward to hearing an answer.
Julio.
Comments: Enabled
Some of you may have noticed a few weeks ago that a text area for submitting comments appeared in the Pictures section of the site. Unfortunately, entering comments into the comment box would never actually produce any results. Good news! Commenting is now enabled. Feel free to browse through pictures and leave a comment if the mood strikes.
As you're posting your comments, you may find it peculiar that you don't have to sign in to anything to leave a comment and you may wonder why that is, given that Picasa does not allow anonymous comments. Well my philosophy has always been that if you have a feature that you want people to use, you should make it as easy and accessible to the user as possible. I saw having to login to your Google account as obtrusive and a barrier that would probably stop a lot of people from leaving comments. And having to leave this site for Google's login page sort of ruins the continuity of the site. I've had anonymous commenting enabled on my blog for several months now and moderating hasn't been overly time consuming, so I thought up a solution.
The solution is a big workaround and one that a lot of people probably won't be comfortable for themselves. If you'll notice when you view an image on my site (for instance), the comment author is not always the same as when you view an image directly from the PicasaWeb site (for instance). Essentially what I've done is allowed any user to post a comment on any of my photos through my own username. Once a comment is submitted, it logs the person into my Picasa account and posts the comment as though I had said it. Then to keep track of who the poster says they are, the name they entered is appended to the end of the comment, surrounded by a sequence of characters. You can see in PicasaWeb that the sequence of characters is "-={". Any time that sequence is found in a post, the text inside is stripped and set as the author. Anything after the author is discarded.
This method has a few obvious problems. First of all, PicasaWeb is going to fill up with comments posted by me and I can't really control what is posted for a time. It's not like my site gets a lot of traffic from people I don't know, though, so I think that will be fine, and I'm emailed the comments every day so that I can easily moderate them. Just to be safe, a disclaimer is tagged to the bottom of each comment, which you'll only see on the PicasaWeb site. The second problem is that this method is certainly not supported by Google. I doubt they really want me doing this, as it sort of damages the integrity of their comments and accounts. I think they likely have bigger things to worry about, but we'll see. The interesting thing is that the current version of the Google's Picasa API has a bug that will not allow a comment to be posted to an image by anyone except the owner of the Picasa account, so this is actually the only way that anyone except myself could comment on my photos through this site.
So begins the great comment experiment. It was a lot of work, but if it doesn't prove to be successful, I can always switch over to standard, authenticated commenting without too much trouble once the bug is fixed. I'm excited about this new feature and hope that it will be a way to make the site more interactive and get people more interested in seeing what new photos have been posted. Keep in mind that I finished this feature a few hours ago and I do expect some bugs (particularly if you're using Internet Explorer, but you should switch to Firefox anyway) so if it doesn't work for you, let me know and keep trying! I've done several tests and they've been successful thus far. Like I said, it was a lot of work to get comments up and running so I'll post the PHP code for how I got it working soon. I'll also be adding it to version 3.0 of my Picasa API, so look for that in the next month or two.
Comments
Hi Cameron,
Having comments about your photos stored as comments submitted using your Picassa account is a cool workaround to requiring users to login, and your hack may really be the only solution for bloggers who don't have access to a datasource.
I was just thinking, however, that if you do have access to a datasource, such as a database or XML file, you could store comments about your photos on your server!
For instance, if you have a picture called "ducks08.jpg" and someone leaves a comment, you could store the comment in a table with 3 columns, one for the filename/url, one for the comment, and one for the name of the user who left the comment.
An XML mapping could solve the problem as well, but I always get tied in knots with XML :)
However, since I use Blogger, your solution may be the only way someone like me, without access to a server, could enable comments on photos. Excellent article!
Lightweight PHP Picasa API Version 2.0
I haven't had a chance to post in a while, I've been busy preparing an update to the Picasa API I built for the Pictures section of this site. I didn't put a whole lot of effort into making the previous implementation much better than what I needed because I didn't think it would be worthwhile. However, it's been by far the most popular part of my site and I've received some good feedback on it. So now it's time to unveil version 2.0 of the Lightweight PHP Picasa API:
Download the API here.
In the new version I've focused heavily on documentation, because one of the gripes I heard from people was that it was tough to get something started. So I've added Javadoc style commenting to all the files included and will host the Javadocs here in a few days. Also to help things out, I've added several helper functions for doing things like retrieving an album or a photo, etc. So I think it will be much easier to get started if you're downloading it for the first time.
The two new classes I've added to the API itself are the Picasa_Author and Picasa_Comment classes. You probably haven't noticed, but I've started displaying comments on each photo (see this one, for example). I haven't got comment posting to work through the API yet, but at least now I can retrieve them. So the Picasa_Comments class holds comments and the Picasa_Author class holds authors. An author could be the author of an album or a comment, depending on the situation.
If you're already using version 1.0 of the software, don't worry, I've made this one fully backwards compatible. You should be able to replace version 1.0 with version 2.0 and your interacting code should need no update.
As always, if you have any questions or comments, let me know!
Update 04/09/2008: This post is for Version 2.0 of my Lightweight PHP Picasa API. Version 3.0 has since been released, which includes a great deal of expanded functionality. Go get it here for more Picasa PHP fun!
Comments
Well I'm glad someone will be hotly anticipating the next release :)
Just to update everyone, the next version is coming along really well. I've just gotten accessing private albums to work (which was a lot tougher than you might expect...), and it's turning out to be a huge improvement over the current version. I'm working on it whenever I have free time and hope to have it ready in the next two weeks.
Hi,
Thanks for your reply! Sounds great! I will be lazy then and wait for your release ;-) Keep on the good work!
Greetings from Europe
Well, supporting private albums is sort of a tricky question. There is currently no method in the API that will facilitate Google's authorization process, so out of the box there is no way to do it. However, you can write something to request authorization from Picasa and then request a list of private albums. At that point, yes you could store those albums in the API's classes.
I've never needed to do authorization for my purposes until I added commenting to my photos a few weeks ago. Since I've done the work to do that, Version 3.0 of my API will include methods for authorizing an account, posting comments and photos, and I can include fetching non-public albums as well. I'm not entirely sure about a release date but I would think it will take me about a month to finish.
If anyone wants to be alerted when version 3.0 gets released, I don't have a mailing list set up but just send me your email address I'll be sure to send out a mass email once it goes online. I think it will offer a lot of improvements and make the API easier to use, and it will be fully backwards compatible with versions 1 and 2.
Hi,
Seems to be a great API so far. One question: Does this work with non-public albums (as declared in Picasa web)?
Thanks
Yesterday's News
Is was brought to my attention about a week ago that the new version of Zend, released on November 30th, now supports Picasa. This was the support that I was looking for but could not find back in July when I wanted to add pictures to my site and was also the reason that I created my PHP interface for Picasa. So while this is good news for the community, it sort of leaves my work in the dust. I think once the holidays over I'll start moving my current implementation to the new Zend framework, the Pictures section included. I've already had some feedback that it might be a better idea to try to use my work with Zend so who knows, my code may have some life left. If anyone has any feedback on the new Zend framework that they want to share, please email me or leave a comment.
Comments
Just as a quick update, my Picasa API continues to be the most popular part of the site, so as long as people find it useful, I'll continue developing it. If you haven't already tried version 2.0, check it out.
Help With the Picasa API in PHP
I gave some examples for my Picasa API in PHP in an earlier post (here) but I thought it deserved an entire post. The thing that can get confusing is that the API builds its objects using the queries described in Google's documentation. For instance, the code I posted earlier:
public function getAlbumsForDefaultAccount() {
return new Picasa_Account(Cam_Util_PictureUtil::
$BASE_QUERY_URL.'?kind=album');
}
However, this can also be a little tricky. So here's a quick method that will let get you all the public albums for any account. All you need to know is the User ID of the album's owner:
public function getAlbumsByUser($userid) {
return new Picasa_Account('http://picasaweb.google.com/data/feed/
api/user/'.$userid.'?kind=album');
}
Keep in mind that I haven't tested that code, so there could be a typo that I overlooked, but that's the idea. And as I said in the previous post, I would take most of that query string and put it into a constant so that if Google ever changes the format for the URL, it's easy to update all of your queries at once.
In case the idea still isn't clear, how about some code to get all the pictures from an album? All you need is the User ID and the album name:
public function getPicturesByAlbumAndUser($userid,$album) {
return new Picasa_Album('http://picasaweb.google.com/data/feed/
api/user/'.$userid.'/album/'.$album.'?kind=photo');
}
Now you should have an Album object with Picture objects for all the pictures in the album. It will also contain information about the albums such as location, date, etc. The information is all stored in the private members of the Album class and they are accessible through public getter and setter methods.
I hope this helps everyone. If it's still not clear, feel free to let me know. Again, feel free to download my API by clicking here.
Update 04/09/2008: This post is for Version 1.0 of my Lightweight PHP Picasa API. Version 3.0 has since been released, which includes a great deal of expanded functionality. Go get it here for more Picasa PHP fun!
Comments
Starting in version 3.0 of the API, you can upload photos to your Picasa account using PHP. So you could build an interface for someone to upload photos to their own account using this API, for instance.
Does this allow for upload to Picasa via the webpage? That's what I'm trying to figure out,
thanks!
Thank you for your PHP API
I can access my albums and show icon from albums. but when I use $album->getImages() that should be return images object array from an album, but it didn't return anything. I used count($images), it return 0 for all my albums. Please see what's happen or I did something wrong to use your API.
Thanks
Nick
Hmm, strange. Well, I'm away from home on vacation for the next few days but I'll try to get some more examples up after the holidays. If you keep playing with it and figure it out before then, go ahead and post what kind of difficulty you were having and how to solve it. Thanks!
I don't know, how to show pictures on webpage... I can access Account atributes, but I can't access Album... Can you post code to show pictures on page, please.
Nasty little script. Thank you!
Lightweight PHP Picasa API
As I've mentioned before, the Pictures section of this site is run through Picasa, Google's picture service. So I upload all my pictures to Picasa through a local application that they provide, I group them into albums, name them, give them a location, etc, and then they appear on CameronHinkle.com. This works out really well because their interface is nice for uploading photos and I don't have to pay for storage (I'm only using 13% of my total space and I can buy more if I need it). I also like that it's hosted in a central place with a lot of other photos because that means it's not sectioned off in its own little corner of the world. I don't usually get hung up on privacy concerns so the fact that I don't have control over the physical location of the photos does not bother me in the least.
Anyway, all of this magic is brought to you by Picasa's API. When I started this project, I was under the impression that Picasa, like Blogger, had a really slick API written in PHP that I could easily integrate with my site. It was going to be a piece of cake. Well, that turned out to not be the case. There was no existing PHP API, only one in XML, which meant I had to start the task of parsing lots of XML (which fortunately is really easy in PHP). To make things easier, I made my own PHP API that can really be used by anyone. So if you have a Picasa account and you know PHP, this makes it relatively simple to display your Picasa pictures on your website. And now for the first time, I'm publishing it on the web.
Click here to download my lightweight Picasa API in PHP.The API is not great, it does exactly what I need it to do and not a whole lot more. However, it's extraordinarily easy to add on to. Basically it is set up with 4 types of objects that are simple to understand: Accounts, Albums, Images, and ImageCollections. Accounts have Albums, Albums have Images, and ImageCollections also have Images. Everything is pretty self explanatory except possibly ImageCollection, which is just a way to contain several images that are not from the same Album because there are different rules (like ImageCollections aren't given a title). The easiest way to understand how each class works is to look at it's constructor because that will tell you what to pass in to make a given object. Be aware that if you only need one photo, creating an entire Account object will take forever, so there's an easy way to create just a single Image object.
If you want to publish your uploaded photos on the web, this is perfect! If you want to upload your own photos, it's not so good, but it may be a good start. Hopefully someone needs to do more than I did and runs with the idea. However, I assume that there will be a Zend package available for Picasa within the next 6 or 12 months, at which point my API will be completely obsolete. Until then, enjoy!
Update 04/09/2008: This post is for Version 1.0 of my Lightweight PHP Picasa API. Version 3.0 has since been released, which includes a great deal of expanded functionality. Go get it here for more Picasa PHP fun!
UPDATE 12/2/2007: I eventually took the time to post some help with using this download and that article is posted here. I will probably offer additional help later.
Comments
Hi Cameron,
I have written a small script (using yours files) to create a list of all my picasa albums with their icon but I'm not able to give a link to each album. The name of the album is different from the href that I must give to the icon.
Have you got any suggestion?
thanks!
Andrea
Hey Cameron,
just wanna say thanks for such a great work. I just got it running in a test environment. And it works just perfect. I already tried with the Zend API. But it was just to complex for my target. So I am glad you made that job. Easy to use and self explaining source code. Great!!! And besides you created a great info pool with this blog. Loved reading it. Hope, you'll have time (and be motivated) to continue working on it. Eventhough I couldn't point to things having to be improved.
Greez, Andi
I am not so much good in this things but i like to learn with other examples ..i checked this 4 files but i dont know how to include api & album id to this??sorry for my simple doubt ..thanks you
hi Cameron,
i have downloaded your 4 files for picasaweb API in PHP. i somehow couldn't get it to work. I have written a simple script to instantiate the class but i get a lot of errors.
here is what my script that calls the classes :
require_once 'Account.php';
$myPicasa = new Picasa_Account("http://picasaweb.google.com/xxxxxxxx");
the error i got when i tried is quite a lot:
Warning: SimpleXMLElement::__construct() [function.SimpleXMLElement---construct]: Entity: line 7: parser error : EntityRef: expecting ';' in /Picasa/Account.php on line 64
Warning: SimpleXMLElement::__construct() [function.SimpleXMLElement---construct]: aweb.google.com/data/feed/base/user/xxxxxxxxxx kind=album&alt in /home/hensono/public_html/assets/Picasa/Account.php on line 64
Warning: SimpleXMLElement::__construct() [function.SimpleXMLElement---construct]: ^ in /Picasa/Account.php on line 64
would really appreciate your help.
Sure, I can give an example. I should probably take some time and dedicate a whole post on how to do it, but for now I'll just do it here.
The API uses the query structure outlined in Google's documentation. Each data type in my API takes a query (or raw XML) as an argument for the constructor. You form a picasaweb.google.com query URL, send it to the constructor of the data type you're going to use, and it will return the data associated with the query you sent. For instance, here is the code I use to get an array of public albums in my Picasa account:
public function getAlbumsForDefaultAccount() {
return new Picasa_Account(Cam_Util_PictureUtil::$BASE_QUERY_URL.'?kind=album');
}
You can see I've stored the base part of the query (which doesn't ever change throughout my site) into a static field. Then to put the albums into an array:
$account = $picServ->getAlbumsForDefaultAccount();
$account is then an array that I can use in a foreach just like any other array. I use the getter methods for each element in the array to access the individual fields in the Album class.
One thing to keep in mind is that when you create an Account object, it creates each Album object but does not create Picture objects within each Album. This is true in the atom feed and I had initially changed it so that it created each picture object for the entire account, but the performance was terrible.
Hope this helps!
hello, can show us example on how to use your php files? thank you.
Arcadia Beach Roadie 2007
Over Labor Day Weekend, me and the old high school gang got together for a camping trip. While it was without a doubt the worst planned camping trip ever (especially for Labor Day Weekend), it actually turned out pretty well. We had no idea where we were going to stay but we headed out Friday night at about 8:00 for the coast. Without a place to lay our head, we drove up and down the 101 for 45 minutes in the dark of night, stopping wherever we thought we saw a possible campsite. Finally, around 11:00, we found our final destination.
"Camping Prohibited!" said the sign at the front of the beach, but we didn't care. We didn't really have much choice, really. We saw some cars in the parking lot and investigated a little further; indeed, at least 3 other groups had pitched tents on the beach. So we found a place that wasn't too intrusive and started hauling our stuff down the steps to the sand.
Saturday was a gorgeous day. Bright and sunny, but with a little breeze as well. It was one of the nicest days I've spent at the beach. I didn't leave the beach the entire time, except to go back to the car. I did a lot of reading, took a lot of pictures, and watched Heim almost kill himself. Oh yeah, Heim almost killed himself. He climbed up some pretty steep rocks and after he'd gotten about 30 feet off the ground, realized his footing was largely unstable. We realized it too, when we saw large rocks falling from the cliff and making a loud THUD! as they hit the wet sand below. Anyway, he eventually found a way back down, but it was a little tense for a while. He even drew quite a crowd, as you can see in the picture.
The next morning, we awoke to a loud voice, "You are in violation of Oregon State law. It is a $97 fine for camping on the beach. I'm giving you 30 minutes to pack up and leave, at which point I will start handing out citations. You are all banned from the beach for 48 hours." The ranger was pretty cool; he took all of our id information and then pretty much left us along while we packed up. It worked out for the best, really; I wanted to leave early and this gave everyone a reason to pack up as quickly as possible. We're all just glad he somehow missed us on Saturday morning.
In related news, if you'd like to see pictures of our trip, you can now do so here. Some of you may have noticed that the Pictures section is sort of working now. It's not pretty, but you can see all the pictures in my Picasa account, which is a pretty big accomplishment. There aren't any PHP tools available for the Picasa integration like there was for the Blogger integration, so it's ended up being an entirely different experience trying to make the pictures show up. While the style is nowhere near where it needs to be, the pictures are all there. I did a little home-brew API in PHP to handle all the XML parsing from Google's Atom feed. I'll go through what I did to set that up at a later time and post my code for download in case anyone wants it. I'm not taking the time to make it really robust, but if someone wants to add data that I leave out, they can easily add to it. Look for that in the next few weeks and look for the pictures section to be finished later this week.