o g$@sdZddlmZddlmZddlmZddlZddlZddlZddlm Z ddlm Z ddl m Z dd l mZddlZGd d d eZdS) aThis module implements update checking and notification to the user. It provides a context manager around the cache file that stores information about the last update check. The general process is as follows: 1) This stores the last time an update check occurred, so the check will only be done if the update check frequency has expired. 2) When an update check is done, all notifications in the latest snapshot are queried to see if their condition matches the current state of the SDK. Any notifications that match are "activated" and cached. 3) Every time a command is run, Notify() is called to notify the user of available updates. It loops over the activated notifications and determines if any of the triggers match the current command invocation. If there is a match, the notification is printed and the last nag time is recorded for that particular notification. At most one notification is printed per command. The priority is determined by the order the notifications are registered in the component snapshot. )absolute_import)division)unicode_literalsN)config)log)schemas)filesc@seZdZdZdZddZddZddZd d Zd d Z d dZ ddZ ddZ ddZ ddZd!ddZddZddZddZd S)"UpdateCheckDatazBA class to hold update checking data and to perform notifications.iQcCs tj|_d|_||_dS)NF)rPathsupdate_check_cache_path_last_update_check_file_dirty _LoadData_dataselfrE/tmp/google-cloud-sdk/lib/googlecloudsdk/core/updater/update_check.py__init__8s zUpdateCheckData.__init__cCshtj|js tjiSt|j}z t |}tj|WSt y3t dtjiYSw)z%Deserializes data from the json file.zDFailed to parse update check cache file. Using empty cache instead.)ospathisfiler rLastUpdateCheckFromDictionaryrReadFileContentsjsonloads ValueErrorrdebug)rraw_datadatarrrr=s     zUpdateCheckData._LoadDatacCs.|jsdSt|jt|jd|_dS)z!Serializes data to the json file.NF)r rWriteFileContentsr rdumpsr ToDictionaryrrrr _SaveDataKs  zUpdateCheckData._SaveDatacCs|SNrrrrr __enter__SszUpdateCheckData.__enter__cGs |dSr%)r$)rargsrrr__exit__Vs zUpdateCheckData.__exit__cC|jjS)aGets the revision of the snapshot from the last update check. Returns: long, The revision of the last checked snapshot. This is a long int but formatted as an actual date in seconds (i.e 20151009132504). It is *NOT* seconds since the epoch. )rlast_update_check_revisionrrrrLastUpdateCheckRevisionYsz'UpdateCheckData.LastUpdateCheckRevisioncCr))zGets the time of the last update check as seconds since the epoch. Returns: int, The time of the last update check in seconds since the epoch. )rlast_update_check_timerrrrLastUpdateCheckTimecsz#UpdateCheckData.LastUpdateCheckTimecCst|jjS)zzGets the number of seconds since we last did an update check. Returns: int, The amount of time in seconds. )timerr,rrrrSecondsSinceLastUpdateCheckksz+UpdateCheckData.SecondsSinceLastUpdateCheckcCs|tjkS)zChecks if it is time to do an update check. Returns: True, if enough time has elapsed and we should perform another update check. False otherwise. )r/r !UPDATE_CHECK_FREQUENCY_IN_SECONDSrrrrShouldDoUpdateCheckssz#UpdateCheckData.ShouldDoUpdateCheckcCstdd|jjDS)zReturns whether we already know about updates that are available. Returns: bool, True if we know about updates, False otherwise. cSsg|]}|jjr|qSr) conditioncheck_components).0 notificationrrr s z4UpdateCheckData.UpdatesAvailable..)boolr notificationsrrrrUpdatesAvailable}sz UpdateCheckData.UpdatesAvailableFc Cs|s ||jkr=tdtjj}tjj}g}|jj}|D]}|j |||r4td|j | |q||j _|t|j _|j|j _d|_dS)aSets that we just did an update check and found the given snapshot. If the given snapshot is different than the last one we saw, refresh the set of activated notifications for available updates for any notifications with matching conditions. You must call Save() to persist these changes or use this as a context manager. Args: snapshot: snapshots.ComponentSnapshot, The latest snapshot available. component_updates_available: bool, True if there are updates to components we have installed. False otherwise. force: bool, True to force a recalculation of whether there are available updates, even if the snapshot revision has not changed. zUpdating notification cache...zActivating notification: [%s]TN)r+revisionrrrINSTALLATION_CONFIGversionsdk_definitionr8r2Matchesidappendr_CleanUpLastNagTimesr.r,r*r ) rsnapshotcomponent_updates_availableforcecurrent_versioncurrent_revision activatedpossible_notificationsr5rrrSetFromSnapshots$     zUpdateCheckData.SetFromSnapshotc Csntdtjdtdddddtjdddtdddd}|g|j_| t |j_ d|j_ d |_ dS) aSets that we just did an update check and found a new schema version. An incompatible schema version means there are definitely updates available but we can't read the notifications to correctly notify the user. This will install a default notification for the incompatible schema. You must call Save() to persist these changes or use this as a context manager. z.c3s$|] \}}|vr||fVqdSr%r)r4namevalue activated_idsrr sz7UpdateCheckData._CleanUpLastNagTimes..N)rr8dictsix iteritemslast_nag_timesrrrWrrAs    z$UpdateCheckData._CleanUpLastNagTimescCs|tjr tjs dS|jjD]+}|j}|jj|d}|j ||r;tj |j t|jj|<d|_dSqdS)aNotify the user of any available updates. This should be called for every command that is run. It does not actually do an update check, and does not necessarily notify the user each time. The user will only be notified if there are activated notifications and if the trigger for one of the activated notifications matches. At most one notification will be printed per command. Order or priority is determined by the order in which the notifications are registered in the component snapshot file. Args: command_path: str, The '.' separated path of the command that is currently being run (i.e. gcloud.foo.bar). NrT)routisattystatusrr8r?r]getrMr>writer5NotificationMessager.r )r command_pathr5rU last_nag_timerrrNotifys zUpdateCheckData.NotifyN)F)__name__ __module__ __qualname____doc__r0rrr$r&r(r+r-r/r1r9rIrSrArfrrrrr 3s"  ' r )rj __future__rrrrrr.googlecloudsdk.corerrgooglecloudsdk.core.updaterrgooglecloudsdk.core.utilrr[objectr rrrrs