This file is indexed.

/usr/lib/python2.7/dist-packages/gcmclient/gcm.py is in python-gcm-client 0.1.4-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
514
515
# Copyright 2013 Getlogic BV, Sardar Yumatov
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import random
import requests

try:
    import json
except ImportError:
    import omnijson as json

# all you need
__all__ = ('GCMAuthenticationError', 'JSONMessage', 'PlainTextMessage', 'GCM', 'Result')

# More info: http://developer.android.com/google/gcm/gcm.html
#: Default URL to GCM service.
GCM_URL = 'https://android.googleapis.com/gcm/send'

class GCMAuthenticationError(ValueError):
    """ Raised if your Google API key is rejected. """
    pass

class Message(object):
    """ Base message class. """
    # recognized options, read GCM manual for more info.
    OPTIONS = {
        'collapse_key': lambda v: v if isinstance(v, basestring) else str(v),
        'time_to_live': int,
        'delay_while_idle': bool,
        'restricted_package_name': lambda v: v if isinstance(v, basestring) else str(v),
        'dry_run': bool,
    }

    def __init__(self, data=None, options=None):
        """ Abstract message.

            :Arguments:
                - `data` (dict): key-value pairs, payload of this message.
                - `options` (dict): GCM options.

            Refer to `GCM <http://developer.android.com/google/gcm/gcm.html#request>`_
            for more explanation on available options.

            :Options:
                - `collapse_key` (str): collapse key/bucket.
                - `time_to_live` (int): message TTL in seconds.
                - `delay_while_idle` (bool): hold message if device is off-line.
                - `restricted_package_name` (str): declare package name.
                - `dry_run` (bool): pretend sending message to devices.
        """
        self.data = data
        self.options = options or {}

    def _prepare_data(self, payload, data=None):
        """ Hook to format message data payload. """
        data = data or self.data
        if data:
            payload['data'] = data

    def _prepare_payload(self, data=None, options=None):
        """ Hook to prepare all message options. """
        options = options or self.options
        payload = {}

        # set options
        for opt, flt in self.OPTIONS.iteritems():
            val = options.get(opt, None)
            if val is not None:
                val = flt(val)

            if val or isinstance(val, (int, long)):
                payload[opt] = val

        self._prepare_data(payload, data=data)
        return payload

    def _prepare(self, headers, data=None, options=None):
        """ Prepare message for HTTP request.
        
            The method should at least set 'Content-Type' header.  If message
            is using URL encoding (plain-text HTTP request), then method should
            return key-value pairs in a dict.
        
            Arguments:
                headers (dict): HTTP headers.

            Returns:
                HTTP payload (str or dict).
        """
        headers['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8'
        # return dict, will be URLencoded by requests
        return self._prepare_payload(data=data, options=options)

    def _parse_response(self, response):
        """ Parse GCM response. Subclasses must override this method. """
        raise NotImplementedError


class JSONMessage(Message):
    """ JSON formatted message. """

    def __init__(self, registration_ids, data=None, **options):
        """ Multicast message, uses JSON format.

            :Arguments:
                - `registration_ids` (list): registration ID's of target devices.
                - `data` (dict): key-value pairs of message payload.
                - `options` (kwargs): GCM options, see :class:`Message` for more info.
        """
        if not registration_ids:
            raise ValueError("Empty registration_ids list")

        super(JSONMessage, self).__init__(data, options)
        self._registration_ids = registration_ids

    @property
    def registration_ids(self):
        """ Target registration ID's. """
        return self._registration_ids

    def _prepare_payload(self, data=None, options=None):
        """ Prepare message payload. """
        payload = super(JSONMessage, self)._prepare_payload(data=data, options=options)

        registration_ids = self._registration_ids
        if not isinstance(registration_ids, (list, tuple)):
            registration_ids = list(registration_ids)

        payload['registration_ids'] = registration_ids
        return payload

    def _prepare(self, headers, data=None, options=None):
        """ Serializes messaget to JSON. """
        headers['Content-Type'] = 'application/json'
        payload = self._prepare_payload(data=data, options=options)
        return json.dumps(payload)

    def _parse_response(self, response):
        """ Parse JSON response. """
        if not isinstance(response, basestring):
            # requests.Response object
            response = response.content

        data = json.loads(response) # raises ValueError
        if 'results' not in data or len(data.get('results')) != len(self.registration_ids):
            raise ValueError("Invalid response")

        success = {}
        canonicals = {}
        unavailable = []
        not_registered = []
        errors = {}
        for reg_id, res in zip(self.registration_ids, data['results']):
            if 'message_id' in res:
                success[reg_id] = res['message_id']
                if 'registration_id' in res:
                    canonicals[reg_id] = res['registration_id']
            else:
                if res['error'] == "Unavailable" or res['error'] == "InternalServerError":
                    unavailable.append(reg_id)
                elif res['error'] == "NotRegistered":
                    not_registered.append(reg_id)
                else:
                    errors[reg_id] = res['error']

        return {
            'multicast_id': data['multicast_id'],
            'success': success,
            'canonicals': canonicals,
            'unavailable': unavailable,
            'not_registered': not_registered,
            'failed': errors,
        }

    def _retry(self, unavailable):
        """ Create new message for given unavailable ID's list. """
        return JSONMessage(unavailable, self.data, **self.options)

    def __getstate__(self):
        """ Returns ``dict`` with ``__init__`` arguments.

            If you use ``pickle``, then simply pickle/unpickle the message object.
            If you use something else, like JSON, then::
                
                # obtain state dict from message
                state = message.__getstate__()
                # send/store the state
                # recover state and restore message. you have to pick the right class
                message_copy = JSONMessage(**state)

            :Returns:
                `kwargs` for `JSONMessage` constructor.
        """
        ret = dict((key, getattr(self, key)) for key in ('registration_ids', 'data'))
        if self.options:
            ret.update(self.options)

        return ret
    
    def __setstate__(self, state):
        """ Overwrite message state with given kwargs. """
        self.options = {}
        for key, val in state.iteritems():
            if key == 'registration_ids':
                self._registration_ids = val
            elif key == 'data':
                self.data = val
            else:
                self.options[key] = val


class PlainTextMessage(Message):
    """ Plain-text unicast message. """

    def __init__(self, registration_id, data=None, **options):
        """ Unicast message, uses plain text format.
            All values in the data payload must be URL encodable scalars.

            :Arguments:
                - `registration_id` (str): registration ID of target device.
                - `data` (dict): key-value pairs of message payload.
                - `options` (kwargs): GCM options, see :class:`Message` for more info.
        """
        if not registration_id:
            raise ValueError("registration_id is required")

        super(PlainTextMessage, self).__init__(data, options)
        self._registration_id = registration_id

    @property
    def registration_id(self):
        """ Target registration ID. """
        return self._registration_id

    def _prepare_data(self, payload, data=None):
        """ Prepare data key-value pairs for URL encoding. """
        data = data or self.data
        if data:
            for k,v in data.iteritems():
                if v is not None:
                    # FIXME: maybe we should check here if v is scalar. URL encoding
                    # does not support complex values.
                    payload['data.%s' % k] = v

    def _prepare_payload(self, data=None, options=None):
        """ Prepare message payload. """
        payload = super(PlainTextMessage, self)._prepare_payload(data=data, options=options)
        payload['registration_id'] = self.registration_id
        return payload

    def _parse_response(self, response):
        """ Parse plain-text response. """
        success = {}
        canonicals = {}
        not_registered = []
        errors = {}

        if not isinstance(response, basestring):
            # requests.Response object
            response = response.content

        lines = response.strip().split('\n')
        if lines[0].startswith("Error="):
            error_code = lines[0][6:].strip()
            if error_code == "NotRegistered":
                not_registered.append(self.registration_id)
            else:
                # Plain-text requests will never return Unavailable as the error code,
                # they would have returned a 500 HTTP status instead
                errors[self.registration_id] = error_code
        elif lines[0].startswith("id="):
            success[self.registration_id] = lines[0][3:].strip()
            if len(lines) > 1:
                if lines[1].startswith("registration_id="):
                    canonicals[self.registration_id] = lines[1][16:]
                else:
                    raise ValueError("Can not parse second line of response body: {0}".format(lines[1]))
        else:
            raise ValueError("Can not parse response body: {0}".format(response))

        return {
            'success': success,
            'canonicals': canonicals,
            'not_registered': not_registered,
            'failed': errors,
        }

    def _retry(self, unavailable):
        """ Create new message for given unavailable ID's list. """
        if len(unavailable) != 1:
            raise ValueError("Plain-text messages are unicast.")

        return PlainTextMessage(unavailable[0], self.data, **self.options)

    def __getstate__(self):
        """ Returns ``dict`` with ``__init__`` arguments.

            If you use ``pickle``, then simply pickle/unpickle the message object.
            If you use something else, like JSON, then::
                
                # obtain state dict from message
                state = message.__getstate__()
                # send/store the state
                # recover state and restore message. you have to pick the right class
                message_copy = PlainTextMessage(**state)

            :Returns:
                `kwargs` for `PlainTextMessage` constructor.
        """
        ret = dict((key, getattr(self, key)) for key in ('registration_id', 'data'))
        if self.options:
            ret.update(self.options)

        return ret
    
    def __setstate__(self, state):
        """ Overwrite message state with given kwargs. """
        self.options = {}
        for key, val in state.iteritems():
            if key == 'registration_id':
                self._registration_id = val
            elif key == 'data':
                self.data = val
            else:
                self.options[key] = val

class Result(object):
    """ Result of send operation.
    
        You should check :func:`canonical` for any registration ID's that
        should be updated. If the whole message or some registration ID's have
        recoverably failed, then :func:`retry` will provide you with new
        message. You have to wait :func:`delay` seconds before attempting a new
        request.
    """
    
    def __init__(self, message, response, backoff):
        self.message = message
        self._random = None
        self._backoff = backoff

        try:
            # on failures, retry-after
            self.retry_after = response.headers.get('Retry-After', 0)
            if self.retry_after < 1:
                self.retry_after = None
        except ValueError:
            self.retry_after = None

        if response.status_code != 200: # For all 5xx Google says "you may retry"
            self._retry_message = message
            self._success_ids = {}
            self._canonical_ids = {}
            self._not_registered_ids = []
            self._failed_ids = {}
        else:
            info = message._parse_response(response)
            self._success_ids = info['success']
            self._canonical_ids = info['canonicals']
            self._not_registered_ids = info['not_registered']
            self._failed_ids = info['failed']

            # user has to retry anyway, so pre-create
            unavailable = info.get('unavailable', None)
            if unavailable:
                self._retry_message = message._retry(unavailable)
            else:
                self._retry_message = None

    @property
    def success(self):
        """ Successfully processed registration ID's as mapping ``{registration_id: message_id}``. """
        return self._success_ids

    @property
    def canonical(self):
        """ New registration ID's as mapping ``{registration_id: canonical_id}``.

            You have to update registration ID's of your subscribers by
            replacing them with corresponding canonical ID. Read more `here
            <http://developer.android.com/google/gcm/adv.html#canonical>`_.
        """
        return self._canonical_ids

    @property
    def not_registered(self):
        """ List all registration ID's that GCM reports as ``NotRegistered``.
            You should remove them from your database.
        """
        return self._not_registered_ids

    @property
    def failed(self):
        """ Unrecoverably failed regisration ID's as mapping ``{registration_id: error code}``.

            This method lists devices, that have failed with something else than:

                - ``Unavailable`` -- look for :func:`retry` instead.
                - ``NotRegistered`` -- look for :attr:`not_registered` instead.

            Read more about possible `error codes
            <http://developer.android.com/google/gcm/gcm.html#error_codes>`_.
        """
        return self._failed_ids

    def needs_retry(self):
        """ True if :func:`retry` will return message. """
        return self._retry_message is not None

    def retry(self):
        """ Construct new message that will unicast/multicast to remaining
            recoverably failed registration ID's. Method returns None if there
            is nothing to retry. Do not forget to wait for :func:`delay`
            seconds before new attempt.
        """
        return self._retry_message

    def delay(self, retry=0):
        """ Time to wait in seconds before attempting a retry as a float number.

            This method will return value of Retry-After header if it is
            provided by GCM. Otherwise, it will return (backoff * 2^retry) with
            some random shift. Google may black list your server if you do not
            honor Retry-After hint and do not use exponential backoff.
        """
        if self.retry_after:
            return self.retry_after

        return self.backoff(retry=retry)

    def backoff(self, retry=0):
        """ Computes exponential backoff for given retry number. """
        if self._random is None:
            self._random = random.Random()

        base = (self._backoff << retry) - (self._backoff >> 1)
        return (base + self._random.randrange(self._backoff)) / 1000.0


class GCM(object):
    """ GCM client. """

    # Initial backoff in milliseconds
    INITIAL_BACKOFF = 1000

    def __init__(self, api_key, url=GCM_URL, backoff=INITIAL_BACKOFF, **options):
        """ Create new connection.

            :Arguments:
                - `api_key` (str): Google API key.
                - `url` (str): GCM server URL.
                - `backoff` (int): initial backoff in milliseconds.
                - `options` (kwargs): options for `requests <http://docs.python-requests.org/en/latest/api/>`_ such as ``proxies``.
        """
        if not api_key:
            raise ValueError("Google API key is required")

        self.api_key = api_key
        self.url = url
        self.backoff = backoff
        self.requests_options = options

    def send(self, message):
        """ Send message.
            
            The message may contain various options, such as ``time_to_live``.
            Your request might be rejected, because some of your options might
            be invalid. In this case a ``ValueError`` with explanation will be
            raised.

            :Arguments:
                `message` (:class:`Message`): plain text or JSON message.

            :Returns:
                :class:`Result` interpreting the results.

            :Raises:
                - ``requests.exceptions.RequestException`` on any network problem.
                - ``ValueError`` if your GCM request or response is rejected.
                - :class:`GCMAuthenticationError` your API key is invalid.
        """
        headers = {
            'Authorization': 'key=%s' % self.api_key,
        }

        # construct HTTP message
        data = message._prepare(headers)

        # raises requests.exceptions.RequestException on timeouts, connection and
        # other problems.
        response = requests.post(self.url, data=data, headers=headers, **self.requests_options)

        # invalid JSON. Body contains explanation. Happens if options are invalid.
        if response.status_code == 400:
            raise ValueError(response.content)

        if response.status_code == 401:
            raise GCMAuthenticationError("Authentication Error")

        # either request is accepted or rejected with possibility for retry
        if response.status_code == 200 or (response.status_code >= 500 and response.status_code <= 599):
            return Result(message, response, self.backoff)

        assert False, "Unknown status code: {0}".format(response.status_code)