2 This class brings together a L{solve.Solver} to choose a set of implmentations, a
3 L{fetch.Fetcher} to download additional components, and the user's configuration
7 # Copyright (C) 2009, Thomas Leonard
8 # See the README file for details, or visit http://0install.net.
10 from zeroinstall
import _
13 from logging
import info
, debug
, warn
16 from zeroinstall
import SafeException
17 from zeroinstall
.injector
import arch
18 from zeroinstall
.injector
.model
import Interface
, Implementation
, network_levels
, network_offline
, DistributionImplementation
, network_full
19 from zeroinstall
.injector
.namespaces
import config_site
, config_prog
, injector_gui_uri
20 from zeroinstall
.support
import tasks
, basedir
21 from zeroinstall
.injector
.iface_cache
import iface_cache
23 # If we started a check within this period, don't start another one:
24 FAILED_CHECK_DELAY
= 60 * 60 # 1 Hour
27 """Chooses a set of implementations based on a policy.
29 1. Create a Policy object, giving it the URI of the program to be run and a handler.
30 2. Call L{solve_with_downloads}. If more information is needed, a L{fetch.Fetcher} will be used to download it.
31 3. When all downloads are complete, the L{solver} contains the chosen versions.
32 4. Use L{get_uncached_implementations} to find where to get these versions and download them
33 using L{download_uncached_implementations}.
35 @ivar target_arch: target architecture for binaries
36 @type target_arch: L{arch.Architecture}
37 @ivar root: URI of the root interface
38 @ivar solver: solver used to choose a set of implementations
39 @type solver: L{solve.Solver}
40 @ivar watchers: callbacks to invoke after recalculating
41 @ivar help_with_testing: default stability policy
42 @type help_with_testing: bool
43 @ivar network_use: one of the model.network_* values
44 @ivar freshness: seconds allowed since last update
46 @ivar handler: handler for main-loop integration
47 @type handler: L{handler.Handler}
48 @ivar src: whether we are looking for source code
50 @ivar stale_feeds: set of feeds which are present but haven't been checked for a long time
51 @type stale_feeds: set
53 __slots__
= ['root', 'watchers',
54 'freshness', 'handler', '_warned_offline',
55 'target_arch', 'src', 'stale_feeds', 'solver', '_fetcher']
57 help_with_testing
= property(lambda self
: self
.solver
.help_with_testing
,
58 lambda self
, value
: setattr(self
.solver
, 'help_with_testing', value
))
60 network_use
= property(lambda self
: self
.solver
.network_use
,
61 lambda self
, value
: setattr(self
.solver
, 'network_use', value
))
63 implementation
= property(lambda self
: self
.solver
.selections
)
65 ready
= property(lambda self
: self
.solver
.ready
)
67 def __init__(self
, root
, handler
= None, src
= False):
69 @param root: The URI of the root interface (the program we want to run).
70 @param handler: A handler for main-loop integration.
71 @type handler: L{zeroinstall.injector.handler.Handler}
72 @param src: Whether we are looking for source code.
76 self
.freshness
= 60 * 60 * 24 * 30
77 self
.src
= src
# Root impl must be a "src" machine type
78 self
.stale_feeds
= set()
80 from zeroinstall
.injector
.solver
import DefaultSolver
81 self
.solver
= DefaultSolver(network_full
, iface_cache
, iface_cache
.stores
)
83 # If we need to download something but can't because we are offline,
84 # warn the user. But only the first time.
85 self
._warned
_offline
= False
88 # (allow self for backwards compat)
89 self
.handler
= handler
or self
91 debug(_("Supported systems: '%s'"), arch
.os_ranks
)
92 debug(_("Supported processors: '%s'"), arch
.machine_ranks
)
94 path
= basedir
.load_first_config(config_site
, config_prog
, 'global')
97 config
= ConfigParser
.ConfigParser()
99 self
.solver
.help_with_testing
= config
.getboolean('global',
101 self
.solver
.network_use
= config
.get('global', 'network_use')
102 self
.freshness
= int(config
.get('global', 'freshness'))
103 assert self
.solver
.network_use
in network_levels
, self
.solver
.network_use
104 except Exception, ex
:
105 warn(_("Error loading config: %s"), str(ex
) or repr(ex
))
109 self
.target_arch
= arch
.get_host_architecture()
113 if not self
._fetcher
:
115 self
._fetcher
= fetch
.Fetcher(self
.handler
)
118 def set_root(self
, root
):
119 """Change the root interface URI."""
120 assert isinstance(root
, (str, unicode))
122 for w
in self
.watchers
: w()
124 def save_config(self
):
125 """Write global settings."""
126 config
= ConfigParser
.ConfigParser()
127 config
.add_section('global')
129 config
.set('global', 'help_with_testing', self
.help_with_testing
)
130 config
.set('global', 'network_use', self
.network_use
)
131 config
.set('global', 'freshness', self
.freshness
)
133 path
= basedir
.save_config_path(config_site
, config_prog
)
134 path
= os
.path
.join(path
, 'global')
135 config
.write(file(path
+ '.new', 'w'))
136 os
.rename(path
+ '.new', path
)
138 def recalculate(self
, fetch_stale_interfaces
= True):
139 """@deprecated: see L{solve_with_downloads} """
140 self
.stale_feeds
= set()
142 host_arch
= self
.target_arch
144 host_arch
= arch
.SourceArchitecture(host_arch
)
145 self
.solver
.solve(self
.root
, host_arch
)
147 if self
.network_use
== network_offline
:
148 fetch_stale_interfaces
= False
151 for f
in self
.solver
.feeds_used
:
152 if f
.startswith('/'): continue
153 feed
= iface_cache
.get_feed(f
)
154 if feed
is None or feed
.last_modified
is None:
155 self
.download_and_import_feed_if_online(f
) # Will start a download
156 elif self
.is_stale(feed
):
157 debug(_("Adding %s to stale set"), f
)
158 self
.stale_feeds
.add(iface_cache
.get_interface(f
)) # Legacy API
159 if fetch_stale_interfaces
:
160 self
.download_and_import_feed_if_online(f
) # Will start a download
162 for w
in self
.watchers
: w()
166 def usable_feeds(self
, iface
):
167 """Generator for C{iface.feeds} that are valid for our architecture.
170 if self
.src
and iface
.uri
== self
.root
:
171 # Note: when feeds are recursive, we'll need a better test for root here
172 machine_ranks
= {'src': 1}
174 machine_ranks
= arch
.machine_ranks
176 for f
in iface
.feeds
:
177 if f
.os
in arch
.os_ranks
and f
.machine
in machine_ranks
:
180 debug(_("Skipping '%(feed)s'; unsupported architecture %(os)s-%(machine)s"),
181 {'feed': f
, 'os': f
.os
, 'machine': f
.machine
})
183 def is_stale(self
, feed
):
184 """Check whether feed needs updating, based on the configured L{freshness}.
185 None is considered to be stale.
186 @return: true if feed is stale or missing."""
189 if feed
.url
.startswith('/'):
190 return False # Local feeds are never stale
191 if feed
.last_modified
is None:
192 return True # Don't even have it yet
194 staleness
= now
- (feed
.last_checked
or 0)
195 debug(_("Staleness for %(feed)s is %(staleness).2f hours"), {'feed': feed
, 'staleness': staleness
/ 3600.0})
197 if self
.freshness
== 0 or staleness
< self
.freshness
:
198 return False # Fresh enough for us
200 last_check_attempt
= iface_cache
.get_last_check_attempt(feed
.url
)
201 if last_check_attempt
and last_check_attempt
> now
- FAILED_CHECK_DELAY
:
202 debug(_("Stale, but tried to check recently (%s) so not rechecking now."), time
.ctime(last_check_attempt
))
207 def download_and_import_feed_if_online(self
, feed_url
):
208 """If we're online, call L{fetch.Fetcher.download_and_import_feed}. Otherwise, log a suitable warning."""
209 if self
.network_use
!= network_offline
:
210 debug(_("Feed %s not cached and not off-line. Downloading..."), feed_url
)
211 return self
.fetcher
.download_and_import_feed(feed_url
, iface_cache
)
213 if self
._warned
_offline
:
214 debug(_("Not downloading feed '%s' because we are off-line."), feed_url
)
215 elif feed_url
== injector_gui_uri
:
216 # Don't print a warning, because we always switch to off-line mode to
217 # run the GUI the first time.
218 info(_("Not downloading GUI feed '%s' because we are in off-line mode."), feed_url
)
220 warn(_("Not downloading feed '%s' because we are in off-line mode."), feed_url
)
221 self
._warned
_offline
= True
223 def get_implementation_path(self
, impl
):
224 """Return the local path of impl.
226 @raise zeroinstall.zerostore.NotStored: if it needs to be added to the cache first."""
227 assert isinstance(impl
, Implementation
)
228 if impl
.id.startswith('/'):
230 return iface_cache
.stores
.lookup(impl
.id)
232 def get_implementation(self
, interface
):
233 """Get the chosen implementation.
234 @type interface: Interface
235 @rtype: L{model.Implementation}
236 @raise SafeException: if interface has not been fetched or no implementation could be
238 assert isinstance(interface
, Interface
)
240 if not interface
.name
and not interface
.feeds
:
241 raise SafeException(_("We don't have enough information to "
242 "run this program yet. "
243 "Need to download:\n%s") % interface
.uri
)
245 return self
.implementation
[interface
]
247 if interface
.implementations
:
249 if self
.network_use
== network_offline
:
250 raise SafeException(_("No usable implementation found for '%s'.\n"
251 "This may be because 'Network Use' is set to Off-line.") %
253 raise SafeException(_("No usable implementation found for '%s'.") %
257 def get_cached(self
, impl
):
258 """Check whether an implementation is available locally.
259 @type impl: model.Implementation
262 if isinstance(impl
, DistributionImplementation
):
263 return impl
.installed
264 if impl
.id.startswith('/'):
265 return os
.path
.exists(impl
.id)
268 path
= self
.get_implementation_path(impl
)
275 def get_uncached_implementations(self
):
276 """List all chosen implementations which aren't yet available locally.
277 @rtype: [(L{model.Interface}, L{model.Implementation})]"""
279 for iface
in self
.solver
.selections
:
280 impl
= self
.solver
.selections
[iface
]
281 assert impl
, self
.solver
.selections
282 if not self
.get_cached(impl
):
283 uncached
.append((iface
, impl
))
286 def refresh_all(self
, force
= True):
287 """Start downloading all feeds for all selected interfaces.
288 @param force: Whether to restart existing downloads."""
289 return self
.solve_with_downloads(force
= True)
291 def get_feed_targets(self
, feed_iface_uri
):
292 """Return a list of Interfaces for which feed_iface can be a feed.
293 This is used by B{0launch --feed}.
294 @rtype: [model.Interface]
295 @raise SafeException: If there are no known feeds."""
296 # TODO: what if it isn't cached yet?
297 feed_iface
= iface_cache
.get_interface(feed_iface_uri
)
298 if not feed_iface
.feed_for
:
299 if not feed_iface
.name
:
300 raise SafeException(_("Can't get feed targets for '%s'; failed to load interface.") %
302 raise SafeException(_("Missing <feed-for> element in '%s'; "
303 "this interface can't be used as a feed.") % feed_iface_uri
)
304 feed_targets
= feed_iface
.feed_for
305 debug(_("Feed targets: %s"), feed_targets
)
306 if not feed_iface
.name
:
307 warn(_("Warning: unknown interface '%s'") % feed_iface_uri
)
308 return [iface_cache
.get_interface(uri
) for uri
in feed_targets
]
311 def solve_with_downloads(self
, force
= False):
312 """Run the solver, then download any feeds that are missing or
313 that need to be updated. Each time a new feed is imported into
314 the cache, the solver is run again, possibly adding new downloads.
315 @param force: whether to download even if we're already ready to run."""
317 downloads_finished
= set() # Successful or otherwise
318 downloads_in_progress
= {} # URL -> Download
320 host_arch
= self
.target_arch
322 host_arch
= arch
.SourceArchitecture(host_arch
)
325 self
.solver
.solve(self
.root
, host_arch
)
326 for w
in self
.watchers
: w()
328 if self
.solver
.ready
and not force
:
331 if self
.network_use
== network_offline
and not force
:
332 info(_("Can't choose versions and in off-line mode, so aborting"))
334 # Once we've starting downloading some things,
335 # we might as well get them all.
338 for f
in self
.solver
.feeds_used
:
339 if f
in downloads_finished
or f
in downloads_in_progress
:
341 if f
.startswith('/'):
343 feed
= iface_cache
.get_interface(f
)
344 downloads_in_progress
[f
] = self
.fetcher
.download_and_import_feed(f
, iface_cache
)
346 if not downloads_in_progress
:
349 blockers
= downloads_in_progress
.values()
351 tasks
.check(blockers
, self
.handler
.report_error
)
353 for f
in downloads_in_progress
.keys():
354 if downloads_in_progress
[f
].happened
:
355 del downloads_in_progress
[f
]
356 downloads_finished
.add(f
)
359 def solve_and_download_impls(self
, refresh
= False):
360 """Run L{solve_with_downloads} and then get the selected implementations too.
361 @raise SafeException: if we couldn't select a set of implementations
363 refreshed
= self
.solve_with_downloads(refresh
)
366 tasks
.check(refreshed
)
368 if not self
.solver
.ready
:
369 raise SafeException(_("Can't find all required implementations:") + '\n' +
370 '\n'.join(["- %s -> %s" % (iface
, self
.solver
.selections
[iface
])
371 for iface
in self
.solver
.selections
]))
372 downloaded
= self
.download_uncached_implementations()
375 tasks
.check(downloaded
)
377 def need_download(self
):
378 """Decide whether we need to download anything (but don't do it!)
379 @return: true if we MUST download something (feeds or implementations)
381 host_arch
= self
.target_arch
383 host_arch
= arch
.SourceArchitecture(host_arch
)
384 self
.solver
.solve(self
.root
, host_arch
)
385 for w
in self
.watchers
: w()
387 if not self
.solver
.ready
:
388 return True # Maybe a newer version will work?
390 if self
.get_uncached_implementations():
395 def download_uncached_implementations(self
):
396 """Download all implementations chosen by the solver that are missing from the cache."""
397 assert self
.solver
.ready
, "Solver is not ready!\n%s" % self
.solver
.selections
398 return self
.fetcher
.download_impls([impl
for impl
in self
.solver
.selections
.values() if not self
.get_cached(impl
)],
401 def download_icon(self
, interface
, force
= False):
402 """Download an icon for this interface and add it to the
403 icon cache. If the interface has no icon or we are offline, do nothing.
404 @return: the task doing the import, or None
405 @rtype: L{tasks.Task}"""
406 if self
.network_use
== network_offline
:
407 info("Not downloading icon for %s as we are off-line", interface
)
410 modification_time
= None
412 existing_icon
= iface_cache
.get_icon_path(interface
)
414 file_mtime
= os
.stat(existing_icon
).st_mtime
415 from email
.utils
import formatdate
416 modification_time
= formatdate(timeval
= file_mtime
, localtime
= False, usegmt
= True)
418 return self
.fetcher
.download_icon(interface
, force
, modification_time
)
420 def get_interface(self
, uri
):
421 """@deprecated: use L{iface_cache.IfaceCache.get_interface} instead"""
423 warnings
.warn(_("Policy.get_interface is deprecated!"), DeprecationWarning, stacklevel
= 2)
424 return iface_cache
.get_interface(uri
)