blob: 97315d652ff7f263538e1886e2678499932d87a8 [file] [log] [blame]
Darin Petkovc3fd90c2011-05-11 14:23:00 -07001# Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
rtc@google.comded22402009-10-26 22:36:21 +00002# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
Dale Curtisc9aaf3a2011-08-09 15:47:40 -07005import json
rtc@google.comded22402009-10-26 22:36:21 +00006import os
Chris Sosa05491b12010-11-08 17:14:16 -08007import subprocess
Gilad Arnolde74b3812013-04-22 11:27:38 -07008import sys
Darin Petkov2b2ff4b2010-07-27 15:02:09 -07009import time
Gilad Arnold0c9c8602012-10-02 23:58:58 -070010import urllib2
Don Garrett0ad09372010-12-06 16:20:30 -080011import urlparse
Chris Sosa7c931362010-10-11 19:49:01 -070012
Gilad Arnoldabb352e2012-09-23 01:24:27 -070013import cherrypy
14
Gilad Arnolde74b3812013-04-22 11:27:38 -070015# Allow importing from dev/host/lib when running from source tree.
16lib_dir = os.path.join(os.path.dirname(__file__), 'host', 'lib')
17if os.path.exists(lib_dir) and os.path.isdir(lib_dir):
18 sys.path.insert(1, lib_dir)
19
joychen921e1fb2013-06-28 11:12:20 -070020import build_util
Chris Sosa52148582012-11-15 15:35:58 -080021import autoupdate_lib
Gilad Arnold55a2a372012-10-02 09:46:32 -070022import common_util
joychen7c2054a2013-07-25 11:14:07 -070023import devserver_constants as constants
Gilad Arnoldc65330c2012-09-20 15:17:48 -070024import log_util
Gilad Arnolde74b3812013-04-22 11:27:38 -070025# pylint: disable=F0401
26import update_payload
Chris Sosa05491b12010-11-08 17:14:16 -080027
Gilad Arnoldc65330c2012-09-20 15:17:48 -070028
joychen121fc9b2013-08-02 14:30:30 -070029# If used by client in place of an pre-update version string, forces an update
30# to the client regardless of the relative versions of the payload and client.
31FORCED_UPDATE = 'ForcedUpdate'
32
33# Files needed to serve an update.
34UPDATE_FILES = (
35 constants.UPDATE_FILE,
36 constants.STATEFUL_FILE,
37 constants.METADATA_FILE
38)
39
Gilad Arnoldc65330c2012-09-20 15:17:48 -070040# Module-local log function.
Chris Sosa6a3697f2013-01-29 16:44:43 -080041def _Log(message, *args):
42 return log_util.LogWithTag('UPDATE', message, *args)
Gilad Arnoldc65330c2012-09-20 15:17:48 -070043
rtc@google.comded22402009-10-26 22:36:21 +000044
Gilad Arnold0c9c8602012-10-02 23:58:58 -070045class AutoupdateError(Exception):
46 """Exception classes used by this module."""
47 pass
48
49
Don Garrett0ad09372010-12-06 16:20:30 -080050def _ChangeUrlPort(url, new_port):
51 """Return the URL passed in with a different port"""
52 scheme, netloc, path, query, fragment = urlparse.urlsplit(url)
53 host_port = netloc.split(':')
54
55 if len(host_port) == 1:
56 host_port.append(new_port)
57 else:
58 host_port[1] = new_port
59
60 print host_port
joychen121fc9b2013-08-02 14:30:30 -070061 netloc = '%s:%s' % tuple(host_port)
Don Garrett0ad09372010-12-06 16:20:30 -080062
63 return urlparse.urlunsplit((scheme, netloc, path, query, fragment))
64
Chris Sosa6a3697f2013-01-29 16:44:43 -080065def _NonePathJoin(*args):
66 """os.path.join that filters None's from the argument list."""
67 return os.path.join(*filter(None, args))
Don Garrett0ad09372010-12-06 16:20:30 -080068
Chris Sosa6a3697f2013-01-29 16:44:43 -080069
70class HostInfo(object):
Gilad Arnold286a0062012-01-12 13:47:02 -080071 """Records information about an individual host.
72
73 Members:
74 attrs: Static attributes (legacy)
75 log: Complete log of recorded client entries
76 """
77
78 def __init__(self):
79 # A dictionary of current attributes pertaining to the host.
80 self.attrs = {}
81
82 # A list of pairs consisting of a timestamp and a dictionary of recorded
83 # attributes.
84 self.log = []
85
86 def __repr__(self):
87 return 'attrs=%s, log=%s' % (self.attrs, self.log)
88
89 def AddLogEntry(self, entry):
90 """Append a new log entry."""
91 # Append a timestamp.
92 assert not 'timestamp' in entry, 'Oops, timestamp field already in use'
93 entry['timestamp'] = time.strftime('%Y-%m-%d %H:%M:%S')
94 # Add entry to hosts' message log.
95 self.log.append(entry)
96
Gilad Arnold286a0062012-01-12 13:47:02 -080097
Chris Sosa6a3697f2013-01-29 16:44:43 -080098class HostInfoTable(object):
Gilad Arnold286a0062012-01-12 13:47:02 -080099 """Records information about a set of hosts who engage in update activity.
100
101 Members:
102 table: Table of information on hosts.
103 """
104
105 def __init__(self):
106 # A dictionary of host information. Keys are normally IP addresses.
107 self.table = {}
108
109 def __repr__(self):
110 return '%s' % self.table
111
112 def GetInitHostInfo(self, host_id):
113 """Return a host's info object, or create a new one if none exists."""
114 return self.table.setdefault(host_id, HostInfo())
115
116 def GetHostInfo(self, host_id):
117 """Return an info object for given host, if such exists."""
Chris Sosa1885d032012-11-29 17:07:27 -0800118 return self.table.get(host_id)
Gilad Arnold286a0062012-01-12 13:47:02 -0800119
120
Chris Sosa6a3697f2013-01-29 16:44:43 -0800121class UpdateMetadata(object):
122 """Object containing metadata about an update payload."""
123
124 def __init__(self, sha1, sha256, size, is_delta_format):
125 self.sha1 = sha1
126 self.sha256 = sha256
127 self.size = size
128 self.is_delta_format = is_delta_format
129
130
joychen921e1fb2013-06-28 11:12:20 -0700131class Autoupdate(build_util.BuildObject):
Chris Sosa0356d3b2010-09-16 15:46:22 -0700132 """Class that contains functionality that handles Chrome OS update pings.
133
134 Members:
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700135 urlbase: base URL, other than devserver, for update images.
136 forced_image: path to an image to use for all updates.
137 payload_path: path to pre-generated payload to serve.
138 src_image: if specified, creates a delta payload from this image.
139 proxy_port: port of local proxy to tell client to connect to you
140 through.
Chris Sosa3ae4dc12013-03-29 11:47:00 -0700141 patch_kernel: Patch the kernel when generating updates
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700142 board: board for the image. Needed for pre-generating of updates.
143 copy_to_static_root: copies images generated from the cache to ~/static.
144 private_key: path to private key in PEM format.
Gilad Arnold8318eac2012-10-04 12:52:23 -0700145 critical_update: whether provisioned payload is critical.
146 remote_payload: whether provisioned payload is remotely staged.
147 max_updates: maximum number of updates we'll try to provision.
148 host_log: record full history of host update events.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700149 """
rtc@google.comded22402009-10-26 22:36:21 +0000150
joychened64b222013-06-21 16:39:34 -0700151 _OLD_PAYLOAD_URL_PREFIX = '/static/archive'
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700152 _PAYLOAD_URL_PREFIX = '/static/'
153 _FILEINFO_URL_PREFIX = '/api/fileinfo/'
154
Chris Sosa6a3697f2013-01-29 16:44:43 -0800155 SHA1_ATTR = 'sha1'
156 SHA256_ATTR = 'sha256'
157 SIZE_ATTR = 'size'
158 ISDELTA_ATTR = 'is_delta'
159
joychen121fc9b2013-08-02 14:30:30 -0700160 def __init__(self, xbuddy, urlbase=None, forced_image=None, payload_path=None,
Chris Sosa3ae4dc12013-03-29 11:47:00 -0700161 proxy_port=None, src_image='', patch_kernel=True, board=None,
Chris Sosa0f1ec842011-02-14 16:33:22 -0800162 copy_to_static_root=True, private_key=None,
Chris Sosa52148582012-11-15 15:35:58 -0800163 critical_update=False, remote_payload=False, max_updates= -1,
Chris Sosa6a3697f2013-01-29 16:44:43 -0800164 host_log=False, *args, **kwargs):
Sean O'Connor14b6a0a2010-03-20 23:23:48 -0700165 super(Autoupdate, self).__init__(*args, **kwargs)
joychen121fc9b2013-08-02 14:30:30 -0700166 self.xbuddy = xbuddy
167 self.urlbase = urlbase or None
Chris Sosa0356d3b2010-09-16 15:46:22 -0700168 self.forced_image = forced_image
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700169 self.payload_path = payload_path
Chris Sosa62f720b2010-10-26 21:39:48 -0700170 self.src_image = src_image
Don Garrett0ad09372010-12-06 16:20:30 -0800171 self.proxy_port = proxy_port
Chris Sosa3ae4dc12013-03-29 11:47:00 -0700172 self.patch_kernel = patch_kernel
joychen562699a2013-08-13 15:22:14 -0700173 self.board = board or self.GetDefaultBoardID()
Chris Sosa08d55a22011-01-19 16:08:02 -0800174 self.copy_to_static_root = copy_to_static_root
Chris Sosa0f1ec842011-02-14 16:33:22 -0800175 self.private_key = private_key
Satoru Takabayashid733cbe2011-11-15 09:36:32 -0800176 self.critical_update = critical_update
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700177 self.remote_payload = remote_payload
Jay Srinivasanac69d262012-10-30 19:05:53 -0700178 self.max_updates = max_updates
Gilad Arnold8318eac2012-10-04 12:52:23 -0700179 self.host_log = host_log
Don Garrettfff4c322010-11-19 13:37:12 -0800180
Chris Sosa417e55d2011-01-25 16:40:48 -0800181 self.pregenerated_path = None
Sean O'Connor14b6a0a2010-03-20 23:23:48 -0700182
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700183 # Initialize empty host info cache. Used to keep track of various bits of
Gilad Arnold286a0062012-01-12 13:47:02 -0800184 # information about a given host. A host is identified by its IP address.
185 # The info stored for each host includes a complete log of events for this
186 # host, as well as a dictionary of current attributes derived from events.
187 self.host_infos = HostInfoTable()
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700188
Chris Sosa6a3697f2013-01-29 16:44:43 -0800189 @classmethod
190 def _ReadMetadataFromStream(cls, stream):
191 """Returns metadata obj from input json stream that implements .read()."""
192 file_attr_dict = {}
193 try:
194 file_attr_dict = json.loads(stream.read())
195 except IOError:
196 return None
197
198 sha1 = file_attr_dict.get(cls.SHA1_ATTR)
199 sha256 = file_attr_dict.get(cls.SHA256_ATTR)
200 size = file_attr_dict.get(cls.SIZE_ATTR)
201 is_delta = file_attr_dict.get(cls.ISDELTA_ATTR)
202 return UpdateMetadata(sha1, sha256, size, is_delta)
203
204 @staticmethod
205 def _ReadMetadataFromFile(payload_dir):
206 """Returns metadata object from the metadata_file in the payload_dir"""
joychen25d25972013-07-30 14:54:16 -0700207 metadata_file = os.path.join(payload_dir, constants.METADATA_FILE)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800208 if os.path.exists(metadata_file):
209 with open(metadata_file, 'r') as metadata_stream:
210 return Autoupdate._ReadMetadataFromStream(metadata_stream)
211
212 @classmethod
213 def _StoreMetadataToFile(cls, payload_dir, metadata_obj):
214 """Stores metadata object into the metadata_file of the payload_dir"""
215 file_dict = {cls.SHA1_ATTR: metadata_obj.sha1,
216 cls.SHA256_ATTR: metadata_obj.sha256,
217 cls.SIZE_ATTR: metadata_obj.size,
218 cls.ISDELTA_ATTR: metadata_obj.is_delta_format}
joychen25d25972013-07-30 14:54:16 -0700219 metadata_file = os.path.join(payload_dir, constants.METADATA_FILE)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800220 with open(metadata_file, 'w') as file_handle:
221 json.dump(file_dict, file_handle)
222
Chris Sosa52148582012-11-15 15:35:58 -0800223 @staticmethod
224 def _GetVersionFromDir(image_dir):
Chris Sosa0356d3b2010-09-16 15:46:22 -0700225 """Returns the version of the image based on the name of the directory."""
226 latest_version = os.path.basename(image_dir)
Daniel Erat8a0bc4a2011-09-30 08:52:52 -0700227 parts = latest_version.split('-')
joychen121fc9b2013-08-02 14:30:30 -0700228 # If we can't get a version number from the directory, default to a high
229 # number to allow the update to happen
230 return parts[1] if len(parts) == 3 else "9999.0.0"
Chris Sosa0356d3b2010-09-16 15:46:22 -0700231
Chris Sosa52148582012-11-15 15:35:58 -0800232 @staticmethod
233 def _CanUpdate(client_version, latest_version):
Don Garrettf90edf02010-11-16 17:36:14 -0800234 """Returns true if the latest_version is greater than the client_version.
235 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800236 _Log('client version %s latest version %s', client_version, latest_version)
Daniel Erat8a0bc4a2011-09-30 08:52:52 -0700237
238 client_tokens = client_version.replace('_', '').split('.')
Daniel Erat8a0bc4a2011-09-30 08:52:52 -0700239 latest_tokens = latest_version.replace('_', '').split('.')
Daniel Erat8a0bc4a2011-09-30 08:52:52 -0700240
joychen121fc9b2013-08-02 14:30:30 -0700241 if len(latest_tokens) == len(client_tokens) == 3:
242 return latest_tokens > client_tokens
Chris Sosa0356d3b2010-09-16 15:46:22 -0700243 else:
joychen121fc9b2013-08-02 14:30:30 -0700244 # If the directory name isn't a version number, let it pass.
245 return True
Chris Sosa0356d3b2010-09-16 15:46:22 -0700246
Chris Sosa52148582012-11-15 15:35:58 -0800247 @staticmethod
Gilad Arnolde74b3812013-04-22 11:27:38 -0700248 def IsDeltaFormatFile(filename):
Andrew de los Reyes5679b972010-10-25 17:34:49 -0700249 try:
Gilad Arnolde74b3812013-04-22 11:27:38 -0700250 with open(filename) as payload_file:
251 payload = update_payload.Payload(payload_file)
252 payload.Init()
253 return payload.IsDelta()
254 except (IOError, update_payload.PayloadError):
255 # For unit tests we may not have real files, so it's ok to ignore these
256 # errors.
Andrew de los Reyes5679b972010-10-25 17:34:49 -0700257 return False
258
Don Garrettf90edf02010-11-16 17:36:14 -0800259 def GenerateUpdateFile(self, src_image, image_path, output_dir):
Chris Sosa0356d3b2010-09-16 15:46:22 -0700260 """Generates an update gz given a full path to an image.
261
262 Args:
263 image_path: Full path to image.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800264 Raises:
265 subprocess.CalledProcessError if the update generator fails to generate a
266 stateful payload.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700267 """
joychen7c2054a2013-07-25 11:14:07 -0700268 update_path = os.path.join(output_dir, constants.UPDATE_FILE)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800269 _Log('Generating update image %s', update_path)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700270
Chris Sosa0f1ec842011-02-14 16:33:22 -0800271 update_command = [
Chris Sosa5b8b5eb2012-03-27 11:15:27 -0700272 'cros_generate_update_payload',
Chris Sosa6a3697f2013-01-29 16:44:43 -0800273 '--image', image_path,
274 '--output', update_path,
Chris Sosa0f1ec842011-02-14 16:33:22 -0800275 ]
Chris Sosa4136e692010-10-28 23:42:37 -0700276
Chris Sosa52148582012-11-15 15:35:58 -0800277 if src_image:
Chris Sosa6a3697f2013-01-29 16:44:43 -0800278 update_command.extend(['--src_image', src_image])
Chris Sosa52148582012-11-15 15:35:58 -0800279
Chris Sosa3ae4dc12013-03-29 11:47:00 -0700280 if self.patch_kernel:
Chris Sosa52148582012-11-15 15:35:58 -0800281 update_command.append('--patch_kernel')
282
283 if self.private_key:
Chris Sosa6a3697f2013-01-29 16:44:43 -0800284 update_command.extend(['--private_key', self.private_key])
Chris Sosa0f1ec842011-02-14 16:33:22 -0800285
Chris Sosa6a3697f2013-01-29 16:44:43 -0800286 _Log('Running %s', ' '.join(update_command))
287 subprocess.check_call(update_command)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700288
Chris Sosa52148582012-11-15 15:35:58 -0800289 @staticmethod
290 def GenerateStatefulFile(image_path, output_dir):
Don Garrettf90edf02010-11-16 17:36:14 -0800291 """Generates a stateful update payload given a full path to an image.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700292
293 Args:
294 image_path: Full path to image.
Chris Sosa908fd6f2010-11-10 17:31:18 -0800295 Raises:
Chris Sosa6a3697f2013-01-29 16:44:43 -0800296 subprocess.CalledProcessError if the update generator fails to generate a
Chris Sosa908fd6f2010-11-10 17:31:18 -0800297 stateful payload.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700298 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800299 update_command = [
300 'cros_generate_stateful_update_payload',
301 '--image', image_path,
302 '--output_dir', output_dir,
303 ]
304 _Log('Running %s', ' '.join(update_command))
305 subprocess.check_call(update_command)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700306
Don Garrettf90edf02010-11-16 17:36:14 -0800307 def FindCachedUpdateImageSubDir(self, src_image, dest_image):
308 """Find directory to store a cached update.
309
Gilad Arnold55a2a372012-10-02 09:46:32 -0700310 Given one, or two images for an update, this finds which cache directory
311 should hold the update files, even if they don't exist yet.
Don Garrettf90edf02010-11-16 17:36:14 -0800312
Gilad Arnold55a2a372012-10-02 09:46:32 -0700313 Returns:
314 A directory path for storing a cached update, of the following form:
315 Non-delta updates:
316 CACHE_DIR/<dest_hash>
317 Delta updates:
318 CACHE_DIR/<src_hash>_<dest_hash>
319 Signed updates (self.private_key):
320 CACHE_DIR/<src_hash>_<dest_hash>+<private_key_hash>
Chris Sosa744e1472011-09-07 19:32:50 -0700321 """
Gilad Arnold55a2a372012-10-02 09:46:32 -0700322 update_dir = ''
Chris Sosa744e1472011-09-07 19:32:50 -0700323 if src_image:
Gilad Arnold55a2a372012-10-02 09:46:32 -0700324 update_dir += common_util.GetFileMd5(src_image) + '_'
Don Garrettf90edf02010-11-16 17:36:14 -0800325
Gilad Arnold55a2a372012-10-02 09:46:32 -0700326 update_dir += common_util.GetFileMd5(dest_image)
Chris Sosa744e1472011-09-07 19:32:50 -0700327 if self.private_key:
Gilad Arnold55a2a372012-10-02 09:46:32 -0700328 update_dir += '+' + common_util.GetFileMd5(self.private_key)
Chris Sosa744e1472011-09-07 19:32:50 -0700329
Chris Sosa3ae4dc12013-03-29 11:47:00 -0700330 if self.patch_kernel:
Gilad Arnold55a2a372012-10-02 09:46:32 -0700331 update_dir += '+patched_kernel'
Chris Sosa9fba7562012-01-31 10:15:47 -0800332
joychen25d25972013-07-30 14:54:16 -0700333 return os.path.join(constants.CACHE_DIR, update_dir)
Don Garrettf90edf02010-11-16 17:36:14 -0800334
Don Garrettfff4c322010-11-19 13:37:12 -0800335 def GenerateUpdateImage(self, image_path, output_dir):
Don Garrettf90edf02010-11-16 17:36:14 -0800336 """Force generates an update payload based on the given image_path.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700337
Chris Sosade91f672010-11-16 10:05:44 -0800338 Args:
Don Garrettf90edf02010-11-16 17:36:14 -0800339 image_path: full path to the image.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800340 output_dir: the directory to write the update payloads to
341 Raises:
342 AutoupdateError if it failed to generate either update or stateful
343 payload.
Chris Sosade91f672010-11-16 10:05:44 -0800344 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800345 _Log('Generating update for image %s', image_path)
Andrew de los Reyes9a528712010-06-30 10:29:43 -0700346
Chris Sosa6a3697f2013-01-29 16:44:43 -0800347 # Delete any previous state in this directory.
348 os.system('rm -rf "%s"' % output_dir)
349 os.makedirs(output_dir)
rtc@google.comded22402009-10-26 22:36:21 +0000350
Chris Sosa6a3697f2013-01-29 16:44:43 -0800351 try:
352 self.GenerateUpdateFile(self.src_image, image_path, output_dir)
353 self.GenerateStatefulFile(image_path, output_dir)
354 except subprocess.CalledProcessError:
355 os.system('rm -rf "%s"' % output_dir)
356 raise AutoupdateError('Failed to generate update in %s' % output_dir)
Don Garrettf90edf02010-11-16 17:36:14 -0800357
Chris Sosa75490802013-09-30 17:21:45 -0700358 def GenerateUpdateImageWithCache(self, image_path):
Don Garrettf90edf02010-11-16 17:36:14 -0800359 """Force generates an update payload based on the given image_path.
rtc@google.comded22402009-10-26 22:36:21 +0000360
Chris Sosa0356d3b2010-09-16 15:46:22 -0700361 Args:
362 image_path: full path to the image.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700363 Returns:
joychen121fc9b2013-08-02 14:30:30 -0700364 update directory relative to static_image_dir.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800365 Raises:
366 AutoupdateError if it we need to generate a payload and fail to do so.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700367 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800368 _Log('Generating update for src %s image %s', self.src_image, image_path)
Chris Sosae67b78f2010-11-04 17:33:16 -0700369
joychen121fc9b2013-08-02 14:30:30 -0700370 # If it was pregenerated, don't regenerate.
Chris Sosa417e55d2011-01-25 16:40:48 -0800371 if self.pregenerated_path:
372 return self.pregenerated_path
Don Garrettfff4c322010-11-19 13:37:12 -0800373
Chris Sosa75490802013-09-30 17:21:45 -0700374 # Which sub_dir should hold our cached update image.
375 cache_sub_dir = self.FindCachedUpdateImageSubDir(self.src_image, image_path)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800376 _Log('Caching in sub_dir "%s"', cache_sub_dir)
Chris Sosa417e55d2011-01-25 16:40:48 -0800377
joychen121fc9b2013-08-02 14:30:30 -0700378 # The cached payloads exist in a cache dir.
Chris Sosa75490802013-09-30 17:21:45 -0700379 cache_dir = os.path.join(self.static_dir, cache_sub_dir)
joychen121fc9b2013-08-02 14:30:30 -0700380
381 cache_update_payload = os.path.join(cache_dir,
joychen7c2054a2013-07-25 11:14:07 -0700382 constants.UPDATE_FILE)
joychen121fc9b2013-08-02 14:30:30 -0700383 cache_stateful_payload = os.path.join(cache_dir,
joychen25d25972013-07-30 14:54:16 -0700384 constants.STATEFUL_FILE)
Chris Sosa417e55d2011-01-25 16:40:48 -0800385 # Check to see if this cache directory is valid.
joychen121fc9b2013-08-02 14:30:30 -0700386 if not (os.path.exists(cache_update_payload) and
387 os.path.exists(cache_stateful_payload)):
388 self.GenerateUpdateImage(image_path, cache_dir)
Don Garrettf90edf02010-11-16 17:36:14 -0800389
joychen121fc9b2013-08-02 14:30:30 -0700390 # Don't regenerate the image for this devserver instance.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800391 self.pregenerated_path = cache_sub_dir
Chris Sosa65d339b2013-01-21 18:59:21 -0800392
Chris Sosa6a3697f2013-01-29 16:44:43 -0800393 # Generate the cache file.
joychen121fc9b2013-08-02 14:30:30 -0700394 self.GetLocalPayloadAttrs(cache_dir)
Don Garrettf90edf02010-11-16 17:36:14 -0800395
joychen121fc9b2013-08-02 14:30:30 -0700396 return cache_sub_dir
Chris Sosa0356d3b2010-09-16 15:46:22 -0700397
Chris Sosa75490802013-09-30 17:21:45 -0700398 def _SymlinkUpdateFiles(self, target_dir, link_dir):
399 """Symlinks the update-related files from target_dir to link_dir.
joychen121fc9b2013-08-02 14:30:30 -0700400
401 Every time an update is called, clear existing files/symlinks in the
Chris Sosa75490802013-09-30 17:21:45 -0700402 link_dir, and replace them with symlinks to the target_dir.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700403
404 Args:
Chris Sosa75490802013-09-30 17:21:45 -0700405 target_dir: Location of the target files.
406 link_dir: Directory where the links should exist after.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700407 """
Chris Sosa75490802013-09-30 17:21:45 -0700408 _Log('Linking %s to %s', target_dir, link_dir)
409 if link_dir == target_dir:
410 _Log('Cannot symlink into the same directory.')
joychen121fc9b2013-08-02 14:30:30 -0700411 return
412 for f in UPDATE_FILES:
Chris Sosa75490802013-09-30 17:21:45 -0700413 link = os.path.join(link_dir, f)
414 target = os.path.join(target_dir, f)
Alex Deymo3e2d4952013-09-03 21:49:41 -0700415 common_util.SymlinkFile(target, link)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700416
joychen121fc9b2013-08-02 14:30:30 -0700417 def GetUpdateForLabel(self, client_version, label,
418 image_name=constants.TEST_IMAGE_FILE):
419 """Given a label, get an update from the directory.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700420
joychen121fc9b2013-08-02 14:30:30 -0700421 Args:
422 client_version: Current version of the client or FORCED_UPDATE
423 label: the relative directory inside the static dir
424 image_name: If the image type was specified by the update rpc, we try to
425 find an image with this file name first. This is by default
426 "chromiumos_test_image.bin" but can also take any of the values in
427 devserver_constants.ALL_IMAGES
Chris Sosa6a3697f2013-01-29 16:44:43 -0800428 Returns:
joychen121fc9b2013-08-02 14:30:30 -0700429 A relative path to the directory with the update payload.
430 This is the label if an update did not need to be generated, but can
431 be label/cache/hashed_dir_for_update.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800432 Raises:
joychen121fc9b2013-08-02 14:30:30 -0700433 AutoupdateError: If client version is higher than available update found
434 at the directory given by the label.
Don Garrettf90edf02010-11-16 17:36:14 -0800435 """
joychen121fc9b2013-08-02 14:30:30 -0700436 _Log('Update label/file: %s/%s', label, image_name)
437 static_image_dir = _NonePathJoin(self.static_dir, label)
438 static_update_path = _NonePathJoin(static_image_dir, constants.UPDATE_FILE)
439 static_image_path = _NonePathJoin(static_image_dir, image_name)
joychen7c2054a2013-07-25 11:14:07 -0700440
joychen121fc9b2013-08-02 14:30:30 -0700441 # Update the client only if client version is older than available update.
442 latest_version = self._GetVersionFromDir(static_image_dir)
443 if not (client_version == FORCED_UPDATE or
444 self._CanUpdate(client_version, latest_version)):
445 raise AutoupdateError(
446 'Update check received but no update available for client')
Don Garrettee25e552010-11-23 12:09:35 -0800447
joychen121fc9b2013-08-02 14:30:30 -0700448 if label and os.path.exists(static_update_path):
449 # An update payload was found for the given label, return it.
450 return label
451 elif os.path.exists(static_image_path) and common_util.IsInsideChroot():
452 # Image was found for the given label. Generate update if we can.
Chris Sosa75490802013-09-30 17:21:45 -0700453 rel_path = self.GenerateUpdateImageWithCache(static_image_path)
454 # Add links from the static directory to the update.
455 cache_path = _NonePathJoin(self.static_dir, rel_path)
456 self._SymlinkUpdateFiles(cache_path, static_image_dir)
457 return label
Don Garrett0c880e22010-11-17 18:13:37 -0800458
joychen121fc9b2013-08-02 14:30:30 -0700459 # The label didn't resolve.
460 return None
Chris Sosa2c048f12010-10-27 16:05:27 -0700461
462 def PreGenerateUpdate(self):
Chris Sosa417e55d2011-01-25 16:40:48 -0800463 """Pre-generates an update and prints out the relative path it.
464
Chris Sosa6a3697f2013-01-29 16:44:43 -0800465 Returns relative path of the update.
Chris Sosa65d339b2013-01-21 18:59:21 -0800466
Chris Sosa6a3697f2013-01-29 16:44:43 -0800467 Raises:
468 AutoupdateError if it failed to generate the payload.
469 """
470 _Log('Pre-generating the update payload')
joychen121fc9b2013-08-02 14:30:30 -0700471 # Does not work with labels so just use static dir. (empty label)
472 pregenerated_update = self.GetPathToPayload('', FORCED_UPDATE, self.board)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800473 print 'PREGENERATED_UPDATE=%s' % _NonePathJoin(pregenerated_update,
joychen7c2054a2013-07-25 11:14:07 -0700474 constants.UPDATE_FILE)
Chris Sosa417e55d2011-01-25 16:40:48 -0800475 return pregenerated_update
Chris Sosa2c048f12010-10-27 16:05:27 -0700476
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700477 def _GetRemotePayloadAttrs(self, url):
478 """Returns hashes, size and delta flag of a remote update payload.
479
480 Obtain attributes of a payload file available on a remote devserver. This
481 is based on the assumption that the payload URL uses the /static prefix. We
482 need to make sure that both clients (requests) and remote devserver
483 (provisioning) preserve this invariant.
484
485 Args:
486 url: URL of statically staged remote file (http://host:port/static/...)
487 Returns:
488 A tuple containing the SHA1, SHA256, file size and whether or not it's a
489 delta payload (Boolean).
490 """
491 if self._PAYLOAD_URL_PREFIX not in url:
492 raise AutoupdateError(
493 'Payload URL does not have the expected prefix (%s)' %
494 self._PAYLOAD_URL_PREFIX)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800495
joychened64b222013-06-21 16:39:34 -0700496 if self._OLD_PAYLOAD_URL_PREFIX in url:
497 fileinfo_url = url.replace(self._OLD_PAYLOAD_URL_PREFIX,
498 self._FILEINFO_URL_PREFIX)
499 else:
500 fileinfo_url = url.replace(self._PAYLOAD_URL_PREFIX,
501 self._FILEINFO_URL_PREFIX)
502
Chris Sosa6a3697f2013-01-29 16:44:43 -0800503 _Log('Retrieving file info for remote payload via %s', fileinfo_url)
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700504 try:
505 conn = urllib2.urlopen(fileinfo_url)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800506 metadata_obj = Autoupdate._ReadMetadataFromStream(conn)
507 # These fields are required for remote calls.
508 if not metadata_obj:
509 raise AutoupdateError('Failed to obtain remote payload info')
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700510
Chris Sosa6a3697f2013-01-29 16:44:43 -0800511 return metadata_obj
512 except IOError as e:
513 raise AutoupdateError('Failed to obtain remote payload info: %s', e)
514
515 def GetLocalPayloadAttrs(self, payload_dir):
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700516 """Returns hashes, size and delta flag of a local update payload.
517
518 Args:
Chris Sosa6a3697f2013-01-29 16:44:43 -0800519 payload_dir: Path to the directory the payload is in.
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700520 Returns:
521 A tuple containing the SHA1, SHA256, file size and whether or not it's a
522 delta payload (Boolean).
523 """
joychen7c2054a2013-07-25 11:14:07 -0700524 filename = os.path.join(payload_dir, constants.UPDATE_FILE)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800525 if not os.path.exists(filename):
526 raise AutoupdateError('update.gz not present in payload dir %s' %
527 payload_dir)
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700528
Chris Sosa6a3697f2013-01-29 16:44:43 -0800529 metadata_obj = Autoupdate._ReadMetadataFromFile(payload_dir)
530 if not metadata_obj or not (metadata_obj.sha1 and
531 metadata_obj.sha256 and
532 metadata_obj.size):
533 sha1 = common_util.GetFileSha1(filename)
534 sha256 = common_util.GetFileSha256(filename)
535 size = common_util.GetFileSize(filename)
Gilad Arnolde74b3812013-04-22 11:27:38 -0700536 is_delta_format = self.IsDeltaFormatFile(filename)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800537 metadata_obj = UpdateMetadata(sha1, sha256, size, is_delta_format)
538 Autoupdate._StoreMetadataToFile(payload_dir, metadata_obj)
Chris Sosa0356d3b2010-09-16 15:46:22 -0700539
Chris Sosa6a3697f2013-01-29 16:44:43 -0800540 return metadata_obj
541
542 def _ProcessUpdateComponents(self, app, event):
543 """Processes the app and event components of an update request.
544
545 Returns tuple containing forced_update_label, client_version, and board.
Chris Sosa0356d3b2010-09-16 15:46:22 -0700546 """
Chris Sosa6a3697f2013-01-29 16:44:43 -0800547 # Initialize an empty dictionary for event attributes to log.
548 log_message = {}
Jay Srinivasanac69d262012-10-30 19:05:53 -0700549
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700550 # Determine request IP, strip any IPv6 data for simplicity.
551 client_ip = cherrypy.request.remote.ip.split(':')[-1]
Gilad Arnold286a0062012-01-12 13:47:02 -0800552 # Obtain (or init) info object for this client.
553 curr_host_info = self.host_infos.GetInitHostInfo(client_ip)
554
joychen121fc9b2013-08-02 14:30:30 -0700555 client_version = FORCED_UPDATE
Chris Sosa6a3697f2013-01-29 16:44:43 -0800556 board = None
557 if app:
558 client_version = app.getAttribute('version')
559 channel = app.getAttribute('track')
560 board = (app.hasAttribute('board') and app.getAttribute('board')
joychenb0dfe552013-07-30 10:02:06 -0700561 or self.GetDefaultBoardID())
Chris Sosa6a3697f2013-01-29 16:44:43 -0800562 # Add attributes to log message
563 log_message['version'] = client_version
564 log_message['track'] = channel
565 log_message['board'] = board
566 curr_host_info.attrs['last_known_version'] = client_version
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700567
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700568 if event:
Gilad Arnold286a0062012-01-12 13:47:02 -0800569 event_result = int(event[0].getAttribute('eventresult'))
570 event_type = int(event[0].getAttribute('eventtype'))
Gilad Arnoldb11a8942012-03-13 15:33:21 -0700571 client_previous_version = (event[0].getAttribute('previousversion')
572 if event[0].hasAttribute('previousversion')
573 else None)
Gilad Arnold286a0062012-01-12 13:47:02 -0800574 # Store attributes to legacy host info structure
575 curr_host_info.attrs['last_event_status'] = event_result
576 curr_host_info.attrs['last_event_type'] = event_type
577 # Add attributes to log message
578 log_message['event_result'] = event_result
579 log_message['event_type'] = event_type
Gilad Arnoldb11a8942012-03-13 15:33:21 -0700580 if client_previous_version is not None:
581 log_message['previous_version'] = client_previous_version
Gilad Arnold286a0062012-01-12 13:47:02 -0800582
Gilad Arnold8318eac2012-10-04 12:52:23 -0700583 # Log host event, if so instructed.
584 if self.host_log:
585 curr_host_info.AddLogEntry(log_message)
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700586
Chris Sosa6a3697f2013-01-29 16:44:43 -0800587 return (curr_host_info.attrs.pop('forced_update_label', None),
588 client_version, board)
589
590 def _GetStaticUrl(self):
591 """Returns the static url base that should prefix all payload responses."""
592 x_forwarded_host = cherrypy.request.headers.get('X-Forwarded-Host')
593 if x_forwarded_host:
594 hostname = 'http://' + x_forwarded_host
595 else:
596 hostname = cherrypy.request.base
597
598 if self.urlbase:
599 static_urlbase = self.urlbase
Chris Sosa6a3697f2013-01-29 16:44:43 -0800600 else:
601 static_urlbase = '%s/static' % hostname
602
603 # If we have a proxy port, adjust the URL we instruct the client to
604 # use to go through the proxy.
605 if self.proxy_port:
606 static_urlbase = _ChangeUrlPort(static_urlbase, self.proxy_port)
607
608 _Log('Using static url base %s', static_urlbase)
609 _Log('Handling update ping as %s', hostname)
610 return static_urlbase
611
joychen121fc9b2013-08-02 14:30:30 -0700612 def GetPathToPayload(self, label, client_version, board):
613 """Find a payload locally.
614
615 See devserver's update rpc for documentation.
616
617 Args:
618 label: from update request
619 client_version: from update request
620 board: from update request
621 Return:
622 The relative path to an update from the static_dir
623 Raises:
624 AutoupdateError: If the update could not be found.
625 """
626 path_to_payload = None
627 #TODO(joychen): deprecate --payload flag
628 if self.payload_path:
629 # Copy the image from the path to '/forced_payload'
630 label = 'forced_payload'
631 dest_path = os.path.join(self.static_dir, label, constants.UPDATE_FILE)
632 dest_stateful = os.path.join(self.static_dir, label,
633 constants.STATEFUL_FILE)
634
635 src_path = os.path.abspath(self.payload_path)
636 src_stateful = os.path.join(os.path.dirname(src_path),
637 constants.STATEFUL_FILE)
638 common_util.MkDirP(os.path.join(self.static_dir, label))
Alex Deymo3e2d4952013-09-03 21:49:41 -0700639 common_util.SymlinkFile(src_path, dest_path)
joychen121fc9b2013-08-02 14:30:30 -0700640 if os.path.exists(src_stateful):
641 # The stateful payload is optional.
Alex Deymo3e2d4952013-09-03 21:49:41 -0700642 common_util.SymlinkFile(src_stateful, dest_stateful)
joychen121fc9b2013-08-02 14:30:30 -0700643 else:
644 _Log('WARN: %s not found. Expected for dev and test builds',
645 constants.STATEFUL_FILE)
646 if os.path.exists(dest_stateful):
647 os.remove(dest_stateful)
648 path_to_payload = self.GetUpdateForLabel(client_version, label)
649 #TODO(joychen): deprecate --image flag
650 elif self.forced_image:
joychendbfe6c92013-08-16 20:03:49 -0700651 if self.forced_image.startswith('xbuddy:'):
652 # This is trying to use an xbuddy path in place of a path to an image.
joychendbfe6c92013-08-16 20:03:49 -0700653 xbuddy_label = self.forced_image.split(':')[1]
654 self.forced_image = None
joychen365a5742013-08-21 10:41:18 -0700655 # Make sure the xbuddy path target is in the directory.
656 path_to_payload, _image_name = self.xbuddy.Get(xbuddy_label.split('/'))
657 # Pretend to have called update with this update path to payload.
Chris Sosa54ef81e2013-08-27 16:45:12 -0700658 self.GetPathToPayload(xbuddy_label, client_version, board)
659 else:
660 src_path = os.path.abspath(self.forced_image)
661 if os.path.exists(src_path) and common_util.IsInsideChroot():
662 # Image was found for the given label. Generate update if we can.
Chris Sosa75490802013-09-30 17:21:45 -0700663 path_to_payload = self.GenerateUpdateImageWithCache(src_path)
664 # Add links from the static directory to the update.
665 cache_path = _NonePathJoin(self.static_dir, path_to_payload)
666 self._SymlinkUpdateFiles(cache_path, self.static_dir)
joychen121fc9b2013-08-02 14:30:30 -0700667 else:
668 label = label or ''
669 label_list = label.split('/')
670 # Suppose that the path follows old protocol of indexing straight
671 # into static_dir with board/version label.
672 # Attempt to get the update in that directory, generating if necc.
673 path_to_payload = self.GetUpdateForLabel(client_version, label)
674 if path_to_payload is None:
675 # There was no update or image found in the directory.
676 # Let XBuddy find an image, and then generate an update to it.
677 if label_list[0] == 'xbuddy':
678 # If path explicitly calls xbuddy, pop off the tag.
679 label_list.pop()
Chris Sosa75490802013-09-30 17:21:45 -0700680 x_label, image_name = self.xbuddy.Translate(label_list, board=board)
joychen121fc9b2013-08-02 14:30:30 -0700681 if image_name not in constants.ALL_IMAGES:
682 raise AutoupdateError(
683 "Use an image alias: dev, base, test, or recovery.")
684 # Path has been resolved, try to get the image.
685 path_to_payload = self.GetUpdateForLabel(client_version, x_label,
686 image_name)
687 if path_to_payload is None:
688 # Neither image nor update payload found after translation.
689 # Try to get an update to a test image from GS using the label.
690 path_to_payload, _image_name = self.xbuddy.Get(
691 ['remote', label, 'full_payload'])
692
693 # One of the above options should have gotten us a relative path.
694 if path_to_payload is None:
695 raise AutoupdateError('Failed to get an update for: %s' % label)
696 else:
Chris Sosa75490802013-09-30 17:21:45 -0700697 return path_to_payload
joychen121fc9b2013-08-02 14:30:30 -0700698
699 def HandleUpdatePing(self, data, label=''):
Chris Sosa6a3697f2013-01-29 16:44:43 -0800700 """Handles an update ping from an update client.
701
702 Args:
703 data: XML blob from client.
704 label: optional label for the update.
705 Returns:
706 Update payload message for client.
707 """
708 # Get the static url base that will form that base of our update url e.g.
709 # http://hostname:8080/static/update.gz.
710 static_urlbase = self._GetStaticUrl()
711
712 # Parse the XML we got into the components we care about.
713 protocol, app, event, update_check = autoupdate_lib.ParseUpdateRequest(data)
714
Chris Sosab26b1202013-08-16 16:40:55 -0700715 # Process attributes of the update check.
716 forced_update_label, client_version, board = self._ProcessUpdateComponents(
717 app, event)
718
joychen121fc9b2013-08-02 14:30:30 -0700719 if not update_check:
720 # TODO(sosa): Generate correct non-updatecheck payload to better test
721 # update clients.
722 _Log('Non-update check received. Returning blank payload')
723 return autoupdate_lib.GetNoUpdateResponse(protocol)
724
Chris Sosa6a3697f2013-01-29 16:44:43 -0800725 if forced_update_label:
726 if label:
727 _Log('Label: %s set but being overwritten to %s by request', label,
728 forced_update_label)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800729 label = forced_update_label
730
joychen121fc9b2013-08-02 14:30:30 -0700731 if self.max_updates == 0:
732 # In case max_updates is used, return no response if max reached.
733 _Log('Request received but max number of updates handled')
734 return autoupdate_lib.GetNoUpdateResponse(protocol)
735
736 _Log('Update Check Received. Client is using protocol version: %s',
737 protocol)
738 self.max_updates -= 1
739
Chris Sosa6a3697f2013-01-29 16:44:43 -0800740 # Finally its time to generate the omaha response to give to client that
741 # lets them know where to find the payload and its associated metadata.
742 metadata_obj = None
743
744 try:
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700745 # Are we provisioning a remote or local payload?
746 if self.remote_payload:
747 # If no explicit label was provided, use the value of --payload.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800748 if not label:
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700749 label = self.payload_path
Chris Sosa0356d3b2010-09-16 15:46:22 -0700750
Chris Sosa52f15bc2013-08-13 17:14:15 -0700751 # TODO(sosa): Remove backwards-compatible hack.
Chris Sosab26b1202013-08-16 16:40:55 -0700752 if not '.bin' in label:
Chris Sosa52f15bc2013-08-13 17:14:15 -0700753 url = _NonePathJoin(static_urlbase, label, 'update.gz')
754 else:
755 url = _NonePathJoin(static_urlbase, label)
Chris Sosa5d342a22010-09-28 16:54:41 -0700756
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700757 # Get remote payload attributes.
Chris Sosa6a3697f2013-01-29 16:44:43 -0800758 metadata_obj = self._GetRemotePayloadAttrs(url)
Gilad Arnold0c9c8602012-10-02 23:58:58 -0700759 else:
joychen121fc9b2013-08-02 14:30:30 -0700760 path_to_payload = self.GetPathToPayload(label, client_version, board)
761 url = _NonePathJoin(static_urlbase, path_to_payload,
joychen7c2054a2013-07-25 11:14:07 -0700762 constants.UPDATE_FILE)
joychen121fc9b2013-08-02 14:30:30 -0700763 local_payload_dir = _NonePathJoin(self.static_dir, path_to_payload)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800764 metadata_obj = self.GetLocalPayloadAttrs(local_payload_dir)
Chris Sosa6a3697f2013-01-29 16:44:43 -0800765 except AutoupdateError as e:
766 # Raised if we fail to generate an update payload.
767 _Log('Failed to process an update: %r', e)
768 return autoupdate_lib.GetNoUpdateResponse(protocol)
769
770 _Log('Responding to client to use url %s to get image', url)
771 return autoupdate_lib.GetUpdateResponse(
772 metadata_obj.sha1, metadata_obj.sha256, metadata_obj.size, url,
773 metadata_obj.is_delta_format, protocol, self.critical_update)
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700774
775 def HandleHostInfoPing(self, ip):
776 """Returns host info dictionary for the given IP in JSON format."""
777 assert ip, 'No ip provided.'
Gilad Arnold286a0062012-01-12 13:47:02 -0800778 if ip in self.host_infos.table:
779 return json.dumps(self.host_infos.GetHostInfo(ip).attrs)
780
781 def HandleHostLogPing(self, ip):
782 """Returns a complete log of events for host in JSON format."""
Gilad Arnold4ba437d2012-10-05 15:28:27 -0700783 # If all events requested, return a dictionary of logs keyed by IP address.
Gilad Arnold286a0062012-01-12 13:47:02 -0800784 if ip == 'all':
785 return json.dumps(
786 dict([(key, self.host_infos.table[key].log)
787 for key in self.host_infos.table]))
Gilad Arnold4ba437d2012-10-05 15:28:27 -0700788
789 # Otherwise we're looking for a specific IP address, so find its log.
Gilad Arnold286a0062012-01-12 13:47:02 -0800790 if ip in self.host_infos.table:
791 return json.dumps(self.host_infos.GetHostInfo(ip).log)
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700792
Gilad Arnold4ba437d2012-10-05 15:28:27 -0700793 # If no events were logged for this IP, return an empty log.
794 return json.dumps([])
795
Dale Curtisc9aaf3a2011-08-09 15:47:40 -0700796 def HandleSetUpdatePing(self, ip, label):
797 """Sets forced_update_label for a given host."""
798 assert ip, 'No ip provided.'
799 assert label, 'No label provided.'
Gilad Arnold286a0062012-01-12 13:47:02 -0800800 self.host_infos.GetInitHostInfo(ip).attrs['forced_update_label'] = label