Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

# Copyright (C) 2008 Jean-Michel Sizun <jm.sizun AT gmail> 

# 

# Copyright (C) 2008 Brent Woodruff 

#   http://www.fprimex.com 

# 

# Copyright (C) 2004 John Sutherland <garion@twcny.rr.com> 

#   http://garion.tzo.com/python/ 

# 

# This library is free software; you can redistribute it and/or 

# modify it under the terms of the GNU Lesser General Public 

# License as published by the Free Software Foundation; either 

# version 2.1 of the License, or (at your option) any later version. 

# 

# This library 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.  See the GNU 

# Lesser General Public License for more details. 

# 

# You should have received a copy of the GNU Lesser General Public 

# License along with this library; if not, write to the Free Software 

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

# 

# 

# Change log: 

# 

# 16-Nov-08 - Migrated from urllib to coherence infrastructure 

# 

# 04-Aug-08 - Added Gallery2 compatibility 

#             Changed fetch_albums and fetch_albums_prune to return dicts 

#             Added docstrings 

#             Created package and registered with Pypi 

# 

# 09-Jun-04 - Removed self.cookie='' from _doRequest to allow multiple 

#             transactions for each login. 

#             Fixed cut paste error in newAlbum. 

#             (both patches from Yuti Takhteyev 

 

import io 

 

from coherence.upnp.core.utils import getPage 

 

 

class Gallery: 

    """ 

    The Gallery class implements the Gallery Remote protocol as documented 

    here: 

    http://codex.gallery2.org/Gallery_Remote:Protocol 

 

    The Gallery project is an open source web based photo album organizer 

    written in php. Gallery's web site is: 

    http://gallery.menalto.com/ 

 

    This class is a 3rd party product which is not maintained by the 

    creators of the Gallery project. 

 

    Example usage: 

    from galleryremote import Gallery 

    my_gallery = Gallery('http://www.yoursite.com/gallery2', 2) 

    my_gallery.login('username','password') 

    albums = my_gallery.fetch_albums() 

    """ 

 

    def __init__(self, url, version=2): 

        """ 

        Create a Gallery for remote access. 

        url - base address of the gallery 

        version - version of the gallery being connected to (default 2), 

                  either 1 for Gallery1 or 2 for Gallery2 

        """ 

        self.version = version  # Gallery1 or Gallery2 

        if version == 1: 

            self.url = url + '/gallery_remote2.php' 

        else: 

            # default to G2 

            self.url = url + '/main.php' 

        self.auth_token = None 

        self.logged_in = 0 

        self.cookie = '' 

        self.protocol_version = '2.5' 

 

    def _do_request(self, request): 

        """ 

        Send a request, encoded as described in the Gallery Remote protocol. 

        request - a dictionary of protocol parameters and values 

        """ 

        if self.auth_token is not None: 

            request['g2_authToken'] = self.auth_token 

 

        url = self.url 

        if len(request) > 0: 

            url += '?' 

            for key, value in request.items(): 

                url += '%s=%s&' % (key, value) 

        headers = {} 

        if self.cookie != '': 

            headers = {'Cookie': self.cookie} 

 

        def gotPage(result): 

            data, headers = result 

            response = self._parse_response(data) 

            if response['status'] != '0': 

                raise Exception(response['status_text']) 

            try: 

                self.auth_token = response['auth_token'] 

            except KeyError: 

                pass 

 

            if 'set-cookie' in headers: 

                cookie_info = headers['set-cookie'][-1] 

                self.cookie = cookie_info.split(';')[0] 

 

            return response 

 

        def gotError(error): 

            print("Unable to process Gallery2 request: %s" % url) 

            print("Error: %s" % error) 

            return None 

 

        d = getPage(url, headers=headers) 

        d.addCallback(gotPage) 

        d.addErrback(gotError) 

        return d 

 

    def _parse_response(self, response): 

        """ 

        Decode the response from a request, returning a request dict 

        response - The response from a gallery request, encoded according 

                   to the gallery remote protocol 

        """ 

        my_str = io.StringIO(response) 

 

        for line in my_str: 

            if line.find('#__GR2PROTO__') != -1: 

                break 

 

        # make sure the 1st line is #__GR2PROTO__ 

        if line.find('#__GR2PROTO__') == -1: 

            raise Exception("Bad response: %r" % response) 

 

        res_dict = {} 

 

        for my_s in my_str: 

            my_s = my_s.strip() 

            str_list = my_s.split('=', 2) 

 

            try: 

                res_dict[str_list[0]] = str_list[1] 

            except Exception: 

                res_dict[str_list[0]] = '' 

 

        return res_dict 

 

    def _get(self, response, kwd): 

        """ 

        """ 

        try: 

            retval = response[kwd] 

        except KeyError: 

            retval = '' 

 

        return retval 

 

    def login(self, username, password): 

        """ 

        Establish an authenticated session to the remote gallery. 

        username - A valid gallery user's username 

        password - That valid user's password 

        """ 

        if self.version == 1: 

            request = { 

                'protocol_version': self.protocol_version, 

                'cmd': 'login', 

                'uname': username, 

                'password': password 

            } 

        else: 

            request = { 

                'g2_controller': 'remote:GalleryRemote', 

                'g2_form[protocol_version]': self.protocol_version, 

                'g2_form[cmd]': 'login', 

                'g2_form[uname]': username, 

                'g2_form[password]': password 

            } 

 

        def gotPage(result): 

            if result is None: 

                print("Unable to login as %s to gallery2  server (%s)" % ( 

                    username, self.url)) 

                return 

            self.logged_in = 1 

 

        d = self._do_request(request) 

        d.addCallbacks(gotPage) 

 

        return d 

 

    def fetch_albums(self): 

        """ 

        Obtain a dict of albums contained in the gallery keyed by 

        album name. In Gallery1, the name is alphanumeric. In Gallery2, 

        the name is the unique identifying number for that album. 

        """ 

        if self.version == 1: 

            request = { 

                'protocol_version': self.protocol_version, 

                'cmd': 'fetch-albums' 

            } 

        else: 

            request = { 

                'g2_controller': 'remote:GalleryRemote', 

                'g2_form[protocol_version]': self.protocol_version, 

                'g2_form[cmd]': 'fetch-albums' 

            } 

 

        d = self._do_request(request) 

 

        def gotResponse(response): 

            if response is None: 

                print("Unable to retrieve list of albums!") 

                return None 

 

            albums = {} 

            for x in range(1, int(response['album_count']) + 1): 

                album = {} 

                album['name'] = self._get( 

                    response, 'album.name.' + str(x)) 

                album['title'] = self._get( 

                    response, 'album.title.' + str(x)) 

                album['summary'] = self._get( 

                    response, 'album.summary.' + str(x)) 

                album['parent'] = self._get( 

                    response, 'album.parent.' + str(x)) 

                album['resize_size'] = self._get( 

                    response, 'album.resize_size.' + str(x)) 

                album['perms.add'] = self._get( 

                    response, 'album.perms.add.' + str(x)) 

                album['perms.write'] = self._get( 

                    response, 'album.perms.write.' + str(x)) 

                album['perms.del_item'] = self._get( 

                    response, 'album.perms.del_item.' + str(x)) 

                album['perms.del_alb'] = self._get( 

                    response, 'album.perms.del_alb.' + str(x)) 

                album['perms.create_sub'] = self._get( 

                    response, 'album.perms.create_sub.' + str(x)) 

                album['perms.info.extrafields'] = self._get( 

                    response, 'album.info.extrafields' + str(x)) 

 

                albums[album['name']] = album 

            return albums 

 

        d.addCallback(gotResponse) 

        return d 

 

    def fetch_albums_prune(self): 

        """ 

        Obtain a dict of albums contained in the gallery keyed by 

        album name. In Gallery1, the name is alphanumeric. In Gallery2, 

        the name is the unique identifying number for that album. 

 

        From the protocol docs: 

        "The fetch_albums_prune command asks the server to return a list 

        of all albums that the user can either write to, or that are 

        visible to the user and contain a sub-album that is writable 

        (including sub-albums several times removed)." 

        """ 

        if self.version == 1: 

            request = { 

                'protocol_version': self.protocol_version, 

                'cmd': 'fetch-albums-prune' 

            } 

        else: 

            request = { 

                'g2_controller': 'remote:GalleryRemote', 

                'g2_form[protocol_version]': self.protocol_version, 

                'g2_form[cmd]': 'fetch-albums-prune' 

            } 

 

        d = self._do_request(request) 

 

        def gotResponse(response): 

            # as long as it comes back here without an exception, we're ok. 

            albums = {} 

 

            for x in range(1, int(response['album_count']) + 1): 

                album = {} 

                album['name'] = self._get( 

                    response, 'album.name.' + str(x)) 

                album['title'] = self._get( 

                    response, 'album.title.' + str(x)) 

                album['summary'] = self._get( 

                    response, 'album.summary.' + str(x)) 

                album['parent'] = self._get( 

                    response, 'album.parent.' + str(x)) 

                album['resize_size'] = self._get( 

                    response, 'album.resize_size.' + str(x)) 

                album['perms.add'] = self._get( 

                    response, 'album.perms.add.' + str(x)) 

                album['perms.write'] = self._get( 

                    response, 'album.perms.write.' + str(x)) 

                album['perms.del_item'] = self._get( 

                    response, 'album.perms.del_item.' + str(x)) 

                album['perms.del_alb'] = self._get( 

                    response, 'album.perms.del_alb.' + str(x)) 

                album['perms.create_sub'] = self._get( 

                    response, 'album.perms.create_sub.' + str(x)) 

                album['perms.info.extrafields'] = self._get( 

                    response, 'album.info.extrafields' + str(x)) 

 

                albums[album['name']] = album 

 

            return albums 

 

        d.addCallback(gotResponse) 

        return d 

 

    def add_item(self, album, filename, caption, description): 

        """ 

        Add a photo to the specified album. 

        album - album name / identifier 

        filename - image to upload 

        caption - string caption to add to the image 

        description - string description to add to the image 

        """ 

        file = open(filename) 

        if self.version == 1: 

            request = { 

                'protocol_version': self.protocol_version, 

                'cmd': 'add-item', 

                'set_albumName': album, 

                'userfile': file, 

                'userfile_name': filename, 

                'caption': caption, 

                'extrafield.Description': description 

            } 

        else: 

            request = { 

                'g2_form[protocol_version]': self.protocol_version, 

                'g2_form[cmd]': 'add-item', 

                'g2_form[set_albumName]': album, 

                'g2_form[userfile]': file, 

                'g2_form[userfile_name]': filename, 

                'g2_form[caption]': caption, 

                'g2_form[extrafield.Description]': description 

            } 

 

        d = self._do_request(request) 

        # if we get here, everything went ok. 

 

        return d 

 

    def album_properties(self, album): 

        """ 

        Obtain album property information for the specified album. 

        album - the album name / identifier to obtain information for 

        """ 

        if self.version == 1: 

            request = { 

                'protocol_version': self.protocol_version, 

                'cmd': 'album-properties', 

                'set_albumName': album 

            } 

        else: 

            request = { 

                'g2_controller': 'remote:GalleryRemote', 

                'g2_form[protocol_version]': self.protocol_version, 

                'g2_form[cmd]': 'album-properties', 

                'g2_form[set_albumName]': album 

            } 

 

        d = self._do_request(request) 

 

        def gotResponse(response): 

            res_dict = {} 

 

            if 'auto_resize' in response: 

                res_dict['auto_resize'] = response['auto_resize'] 

            if 'add_to_beginning' in response: 

                res_dict['add_to_beginning'] = response['add_to_beginning'] 

 

            return res_dict 

 

        d.addCallback(gotResponse) 

        return d 

 

    def new_album(self, parent, name=None, title=None, description=None): 

        """ 

        Add an album to the specified parent album. 

        parent - album name / identifier to contain the new album 

        name - unique string name of the new album 

        title - string title of the album 

        description - string description to add to the image 

        """ 

        if self.version == 1: 

            request = { 

                'g2_controller': 'remote:GalleryRemote', 

                'protocol_version': self.protocol_version, 

                'cmd': 'new-album', 

                'set_albumName': parent 

            } 

            if name is not None: 

                request['newAlbumName'] = name 

            if title is not None: 

                request['newAlbumTitle'] = title 

            if description is not None: 

                request['newAlbumDesc'] = description 

        else: 

            request = { 

                'g2_controller': 'remote:GalleryRemote', 

                'g2_form[protocol_version]': self.protocol_version, 

                'g2_form[cmd]': 'new-album', 

                'g2_form[set_albumName]': parent 

            } 

            if name is not None: 

                request['g2_form[newAlbumName]'] = name 

            if title is not None: 

                request['g2_form[newAlbumTitle]'] = title 

            if description is not None: 

                request['g2_form[newAlbumDesc]'] = description 

 

        d = self._do_request(request) 

 

        def gotResponse(response): 

            return response['album_name'] 

 

        d.addCallback(d) 

        return d 

 

    def fetch_album_images(self, album): 

        """ 

        Get the image information for all images in the specified album. 

        album - specifies the album from which to obtain image information 

        """ 

        if self.version == 1: 

            request = { 

                'protocol_version': self.protocol_version, 

                'cmd': 'fetch-album-images', 

                'set_albumName': album, 

                'albums_too': 'no', 

                'extrafields': 'yes' 

            } 

        else: 

            request = { 

                'g2_controller': 'remote:GalleryRemote', 

                'g2_form[protocol_version]': self.protocol_version, 

                'g2_form[cmd]': 'fetch-album-images', 

                'g2_form[set_albumName]': album, 

                'g2_form[albums_too]': 'no', 

                'g2_form[extrafields]': 'yes' 

            } 

 

        d = self._do_request(request) 

 

        def gotResponse(response): 

            if response is None: 

                print("Unable to retrieve list of item for album %s." % album) 

                return None 

 

            images = [] 

 

            for x in range(1, int(response['image_count']) + 1): 

                image = {} 

                image['name'] = self._get( 

                    response, 'image.name.' + str(x)) 

                image['title'] = self._get( 

                    response, 'image.title.' + str(x)) 

                image['raw_width'] = self._get( 

                    response, 'image.raw_width.' + str(x)) 

                image['raw_height'] = self._get( 

                    response, 'image.raw_height.' + str(x)) 

                image['resizedName'] = self._get( 

                    response, 'image.resizedName.' + str(x)) 

                image['resized_width'] = self._get( 

                    response, 'image.resized_width.' + str(x)) 

                image['resized_height'] = self._get( 

                    response, 'image.resized_height.' + str(x)) 

                image['thumbName'] = self._get( 

                    response, 'image.thumbName.' + str(x)) 

                image['thumb_width'] = self._get( 

                    response, 'image.thumb_width.' + str(x)) 

                image['thumb_height'] = self._get( 

                    response, 'image.thumb_height.' + str(x)) 

                image['raw_filesize'] = self._get( 

                    response, 'image.raw_filesize.' + str(x)) 

                image['caption'] = self._get( 

                    response, 'image.caption.' + str(x)) 

                image['clicks'] = self._get( 

                    response, 'image.clicks.' + str(x)) 

                image['capturedate.year'] = self._get( 

                    response, 'image.capturedate.year' + str(x)) 

                image['capturedate.mon'] = self._get( 

                    response, 'image.capturedate.mon' + str(x)) 

                image['capturedate.mday'] = self._get( 

                    response, 'image.capturedate.mday' + str(x)) 

                image['capturedate.hours'] = self._get( 

                    response, 'image.capturedate.hours' + str(x)) 

                image['capturedate.minutes'] = self._get( 

                    response, 'image.capturedate.minutes' + str(x)) 

                image['capturedate.seconds'] = self._get( 

                    response, 'image.capturedate.seconds' + str(x)) 

                image['description'] = self._get( 

                    response, 'image.extrafield.Description.' + str(x)) 

 

                images.append(image) 

 

            return images 

 

        d.addCallback(gotResponse) 

        return d 

 

    def get_URL_for_image(self, gallery2_id): 

        url = '%s/main.php?g2_view=core.DownloadItem&g2_itemId=%s' % ( 

            self.url, gallery2_id) 

        return url