backend:break dependency between backend and baseimager
[tools/mic.git] / plugins / backend / zypppkgmgr.py
1 #!/usr/bin/python -tt
2 #
3 # Copyright (c) 2010, 2011 Intel, Inc.
4 #
5 # This program is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by the Free
7 # Software Foundation; version 2 of the License
8 #
9 # This program is distributed in the hope that it will be useful, but
10 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 # or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 # for more details.
13 #
14 # You should have received a copy of the GNU General Public License along
15 # with this program; if not, write to the Free Software Foundation, Inc., 59
16 # Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17
18 import os
19 import shutil
20 import urlparse
21 import rpm
22 from mic.utils import runner, fs_related
23
24 import zypp
25 if not hasattr(zypp, 'PoolQuery') or not hasattr(zypp.RepoManager, 'loadSolvFile'):
26     raise ImportError("python-zypp in host system cannot support PoolQuery or loadSolvFile interface, "
27                       "please update it to enhanced version which can be found in repo.meego.com/tools")
28
29 from mic import msger
30 from mic.kickstart import ksparser
31 from mic.utils import rpmmisc
32 from mic.utils.proxy import get_proxy_for
33 from mic.utils.errors import CreatorError
34 from mic.imager.baseimager import BaseImageCreator
35
36 class RepositoryStub:
37     def __init__(self):
38         self.name = None
39         self.baseurl = []
40         self.mirrorlist = None
41         self.proxy = None
42         self.proxy_username = None
43         self.proxy_password = None
44
45         self.enabled = True
46         self.autorefresh = True
47         self.keeppackages = True
48         self.priority = None
49
50 class RepoError(CreatorError):
51     pass
52
53 class RpmError(CreatorError):
54     pass
55
56 from mic.pluginbase import BackendPlugin
57 class Zypp(BackendPlugin):
58     name = 'zypp'
59
60     def __init__(self, target_arch, instroot, cachedir):
61         self.cachedir = cachedir
62         self.instroot  = instroot
63         self.target_arch = target_arch
64
65         self.__pkgs_license = {}
66         self.__pkgs_content = {}
67         self.repos = []
68         self.to_deselect = []
69         self.localpkgs = {}
70         self.repo_manager = None
71         self.repo_manager_options = None
72         self.Z = None
73         self.ts = None
74         self.probFilterFlags = []
75         self.incpkgs = {}
76         self.excpkgs = {}
77
78         self.has_prov_query = True
79
80     def doFileLogSetup(self, uid, logfile):
81         # don't do the file log for the livecd as it can lead to open fds
82         # being left and an inability to clean up after ourself
83         pass
84
85     def closeRpmDB(self):
86         pass
87
88     def close(self):
89         self.closeRpmDB()
90         if not os.path.exists("/etc/fedora-release") and not os.path.exists("/etc/meego-release"):
91             for i in range(3, os.sysconf("SC_OPEN_MAX")):
92                 try:
93                     os.close(i)
94                 except:
95                     pass
96         if self.ts:
97             self.ts.closeDB()
98             self.ts = None
99
100     def __del__(self):
101         self.close()
102
103     def _cleanupRpmdbLocks(self, installroot):
104         # cleans up temporary files left by bdb so that differing
105         # versions of rpm don't cause problems
106         import glob
107         for f in glob.glob(installroot + "/var/lib/rpm/__db*"):
108             os.unlink(f)
109
110     def setup(self, confpath, installroot):
111         self._cleanupRpmdbLocks(installroot)
112         self.installroot = installroot
113
114     def whatObsolete(self, pkg):
115         query = zypp.PoolQuery()
116         query.addKind(zypp.ResKind.package)
117         query.addAttribute(zypp.SolvAttr.obsoletes, pkg)
118         query.setMatchExact()
119         for pi in query.queryResults(self.Z.pool()):
120             return pi
121         return None
122
123     def _splitPkgString(self, pkg):
124         sp = pkg.rsplit(".",1)
125         name = sp[0]
126         arch = None
127         if len(sp) == 2:
128             arch = sp[1]
129             sysarch = zypp.Arch(self.target_arch)
130             if not zypp.Arch(arch).compatible_with (sysarch):
131                 arch = None
132                 name = ".".join(sp)
133         return name, arch
134
135     def selectPackage(self, pkg):
136         """ Select a given package or package pattern, can be specified with name.arch or name* or *name """
137         if not self.Z:
138             self.__initialize_zypp()
139
140         def markPoolItem(obs, pi):
141             if obs == None:
142                 pi.status().setToBeInstalled (zypp.ResStatus.USER)
143             else:
144                 obs.status().setToBeInstalled (zypp.ResStatus.USER)
145
146         found = False
147         startx = pkg.startswith("*")
148         endx = pkg.endswith("*")
149         ispattern = startx or endx
150         name, arch = self._splitPkgString(pkg)
151
152         q = zypp.PoolQuery()
153         q.addKind(zypp.ResKind.package)
154         if ispattern:
155             if startx and not endx:
156                 pattern = '%s$' % (pkg[1:])
157             if endx and not startx:
158                 pattern = '^%s' % (pkg[0:-1])
159             if endx and startx:
160                 pattern = '%s' % (pkg[1:-1])
161             q.setMatchRegex()
162             q.addAttribute(zypp.SolvAttr.name,pattern)
163         elif arch:
164             q.setMatchExact()
165             q.addAttribute(zypp.SolvAttr.name,name)
166         else:
167             q.setMatchExact()
168             q.addAttribute(zypp.SolvAttr.name,pkg)
169
170         for item in sorted(q.queryResults(self.Z.pool()), key=lambda item: str(item.edition()), reverse=True):
171             if item.name() in self.excpkgs.keys() and self.excpkgs[item.name()] == item.repoInfo().name():
172                 continue
173             if item.name() in self.incpkgs.keys() and self.incpkgs[item.name()] != item.repoInfo().name():
174                 continue
175             found = True
176             obspkg = self.whatObsolete(item.name())
177             if arch:
178                 if arch == str(item.arch()):
179                     item.status().setToBeInstalled (zypp.ResStatus.USER)
180             else:
181                 markPoolItem(obspkg, item)
182             if not ispattern:
183                 break
184         # Can't match using package name, then search from packge provides infomation
185         if found == False and not ispattern:
186             q.addAttribute(zypp.SolvAttr.provides, pkg)
187             q.addAttribute(zypp.SolvAttr.name,'')
188             for item in sorted(q.queryResults(self.Z.pool()), key=lambda item: str(item.edition()), reverse=True):
189                 if item.name() in self.excpkgs.keys() and self.excpkgs[item.name()] == item.repoInfo().name():
190                     continue
191                 if item.name() in self.incpkgs.keys() and self.incpkgs[item.name()] != item.repoInfo().name():
192                     continue
193                 found = True
194                 obspkg = self.whatObsolete(item.name())
195                 markPoolItem(obspkg, item)
196                 break
197         if found:
198             return None
199         else:
200             raise CreatorError("Unable to find package: %s" % (pkg,))
201
202     def inDeselectPackages(self, item):
203         """check if specified pacakges are in the list of inDeselectPackages"""
204         name = item.name()
205         for pkg in self.to_deselect:
206             startx = pkg.startswith("*")
207             endx = pkg.endswith("*")
208             ispattern = startx or endx
209             pkgname, pkgarch = self._splitPkgString(pkg)
210             if not ispattern:
211                 if pkgarch:
212                     if name == pkgname and str(item.arch()) == pkgarch:
213                         return True;
214                 else:
215                     if name == pkgname:
216                         return True;
217             else:
218                 if startx and name.endswith(pkg[1:]):
219                         return True;
220                 if endx and name.startswith(pkg[:-1]):
221                         return True;
222         return False;
223
224     def deselectPackage(self, pkg):
225         """collect packages should not be installed"""
226         self.to_deselect.append(pkg)
227
228     def selectGroup(self, grp, include = ksparser.GROUP_DEFAULT):
229         if not self.Z:
230             self.__initialize_zypp()
231         found = False
232         q=zypp.PoolQuery()
233         q.addKind(zypp.ResKind.pattern)
234         for item in q.queryResults(self.Z.pool()):
235             summary = "%s" % item.summary()
236             name = "%s" % item.name()
237             if name == grp or summary == grp:
238                 found = True
239                 item.status().setToBeInstalled (zypp.ResStatus.USER)
240                 break
241
242         if found:
243             if include == ksparser.GROUP_REQUIRED:
244                 map(lambda p: self.deselectPackage(p), grp.default_packages.keys())
245             return None
246         else:
247             raise CreatorError("Unable to find pattern: %s" % (grp,))
248
249     def addRepository(self, name, url = None, mirrorlist = None, proxy = None,
250                       proxy_username = None, proxy_password = None,
251                       inc = None, exc = None, ssl_verify = True, cost=None,
252                       priority=None):
253         # TODO: Handle cost attribute for repos
254         if not self.repo_manager:
255             self.__initialize_repo_manager()
256
257         repo = RepositoryStub()
258         repo.name = name
259         repo.id = name
260         repo.proxy = proxy
261         repo.proxy_username = proxy_username
262         repo.proxy_password = proxy_password
263         repo.ssl_verify = ssl_verify
264         repo.baseurl.append(url)
265         if inc:
266             for pkg in inc:
267                 self.incpkgs[pkg] = name
268         if exc:
269             for pkg in exc:
270                 self.excpkgs[pkg] = name
271
272         # check LICENSE files
273         if not rpmmisc.checkRepositoryEULA(name, repo):
274             msger.warning('skip repo:%s for failed EULA confirmation' % name)
275             return None
276
277         if mirrorlist:
278             repo.mirrorlist = mirrorlist
279
280         # Enable gpg check for verifying corrupt packages
281         repo.gpgcheck = 1
282         if priority:
283             repo.priority = priority
284         self.repos.append(repo)
285
286         try:
287             repo_info = zypp.RepoInfo()
288             repo_info.setAlias(repo.name)
289             repo_info.setName(repo.name)
290             repo_info.setEnabled(repo.enabled)
291             repo_info.setAutorefresh(repo.autorefresh)
292             repo_info.setKeepPackages(repo.keeppackages)
293             baseurl = zypp.Url(repo.baseurl[0])
294             if not ssl_verify:
295                 baseurl.setQueryParam("ssl_verify", "no")
296             if proxy:
297                 (scheme, host, path, parm, query, frag) = urlparse.urlparse(proxy)
298                 proxyinfo = host.split(":")
299                 baseurl.setQueryParam ("proxy", proxyinfo[0])
300                 port = "80"
301                 if len(proxyinfo) > 1:
302                     port = proxyinfo[1]
303                 baseurl.setQueryParam ("proxyport", port)
304             repo_info.addBaseUrl(baseurl)
305             if repo.priority:
306                 repo_info.setPriority(repo.priority)
307             self.repo_manager.addRepository(repo_info)
308             self.__build_repo_cache(name)
309         except RuntimeError, e:
310             raise CreatorError(str(e))
311
312         msger.verbose('repo: %s was added' % name)
313         return repo
314
315     def installHasFile(self, file):
316         return False
317
318     def runInstall(self, checksize = 0):
319         os.environ["HOME"] = "/"
320         self.buildTransaction()
321
322         todo = zypp.GetResolvablesToInsDel(self.Z.pool())
323         installed_pkgs = todo._toInstall
324         dlpkgs = []
325         for item in installed_pkgs:
326             if not zypp.isKindPattern(item) and not self.inDeselectPackages(item):
327                 dlpkgs.append(item)
328
329         # record the total size of installed pkgs
330         pkgs_total_size = sum(map(lambda x: int(x.installSize()), dlpkgs))
331
332         # check needed size before actually download and install
333         if checksize and pkgs_total_size > checksize:
334             raise CreatorError("Size of specified root partition in kickstart file is too small to install all selected packages.")
335
336         # record all pkg and the content
337         localpkgs = self.localpkgs.keys()
338         for pkg in dlpkgs:
339             license = ''
340             if pkg.name() in localpkgs:
341                 hdr = rpmmisc.readRpmHeader(self.ts, self.localpkgs[pkg.name()])
342                 pkg_long_name = "%s-%s-%s.%s.rpm" % (hdr['name'], hdr['version'], hdr['release'], hdr['arch'])
343                 license = hdr['license']
344             else:
345                 pkg_long_name = "%s-%s.%s.rpm" % (pkg.name(), pkg.edition(), pkg.arch())
346                 package = zypp.asKindPackage(pkg)
347                 license = package.license()
348             self.__pkgs_content[pkg_long_name] = {} #TBD: to get file list
349             if license in self.__pkgs_license.keys():
350                 self.__pkgs_license[license].append(pkg_long_name)
351             else:
352                 self.__pkgs_license[license] = [pkg_long_name]
353
354         total_count = len(dlpkgs)
355         cached_count = 0
356         localpkgs = self.localpkgs.keys()
357         msger.info("Checking packages cache and packages integrity ...")
358         for po in dlpkgs:
359             """ Check if it is cached locally """
360             if po.name() in localpkgs:
361                 cached_count += 1
362             else:
363                 local = self.getLocalPkgPath(po)
364                 if os.path.exists(local):
365                     if self.checkPkg(local) != 0:
366                         os.unlink(local)
367                     else:
368                         cached_count += 1
369         download_count =  total_count - cached_count
370         msger.info("%d packages to be installed, %d packages gotten from cache, %d packages to be downloaded" % (total_count, cached_count, download_count))
371         try:
372             if download_count > 0:
373                 msger.info("Downloading packages ...")
374             self.downloadPkgs(dlpkgs, download_count)
375             self.installPkgs(dlpkgs)
376
377         except RepoError, e:
378             raise CreatorError("Unable to download from repo : %s" % (e,))
379         except RpmError, e:
380             raise CreatorError("Unable to install: %s" % (e,))
381
382     def getAllContent(self):
383         return self.__pkgs_content
384
385     def getPkgsLicense(self):
386         return self.__pkgs_license
387
388     def __initialize_repo_manager(self):
389         if self.repo_manager:
390             return
391
392         """ Clean up repo metadata """
393         shutil.rmtree(self.cachedir + "/etc", ignore_errors = True)
394         shutil.rmtree(self.cachedir + "/solv", ignore_errors = True)
395         shutil.rmtree(self.cachedir + "/raw", ignore_errors = True)
396
397         zypp.KeyRing.setDefaultAccept( zypp.KeyRing.ACCEPT_UNSIGNED_FILE
398                                      | zypp.KeyRing.ACCEPT_VERIFICATION_FAILED
399                                      | zypp.KeyRing.ACCEPT_UNKNOWNKEY
400                                      | zypp.KeyRing.TRUST_KEY_TEMPORARILY
401                                      )
402         self.repo_manager_options = zypp.RepoManagerOptions(zypp.Pathname(self.instroot))
403         self.repo_manager_options.knownReposPath = zypp.Pathname(self.cachedir + "/etc/zypp/repos.d")
404         self.repo_manager_options.repoCachePath = zypp.Pathname(self.cachedir)
405         self.repo_manager_options.repoRawCachePath = zypp.Pathname(self.cachedir + "/raw")
406         self.repo_manager_options.repoSolvCachePath = zypp.Pathname(self.cachedir + "/solv")
407         self.repo_manager_options.repoPackagesCachePath = zypp.Pathname(self.cachedir + "/packages")
408
409         self.repo_manager = zypp.RepoManager(self.repo_manager_options)
410
411     def __build_repo_cache(self, name):
412         repo = self.repo_manager.getRepositoryInfo(name)
413         if self.repo_manager.isCached(repo) or not repo.enabled():
414             return
415         self.repo_manager.buildCache(repo, zypp.RepoManager.BuildIfNeeded)
416
417     def __initialize_zypp(self):
418         if self.Z:
419             return
420
421         zconfig = zypp.ZConfig_instance()
422
423         """ Set system architecture """
424         if self.target_arch:
425             zconfig.setSystemArchitecture(zypp.Arch(self.target_arch))
426
427         msger.info("zypp architecture is <%s>" % zconfig.systemArchitecture())
428
429         """ repoPackagesCachePath is corrected by this """
430         self.repo_manager = zypp.RepoManager(self.repo_manager_options)
431         repos = self.repo_manager.knownRepositories()
432         for repo in repos:
433             if not repo.enabled():
434                 continue
435             self.repo_manager.loadFromCache(repo)
436
437         self.Z = zypp.ZYppFactory_instance().getZYpp()
438         self.Z.initializeTarget(zypp.Pathname(self.instroot))
439         self.Z.target().load()
440
441
442     def buildTransaction(self):
443         if not self.Z.resolver().resolvePool():
444             msger.warning("Problem count: %d" % len(self.Z.resolver().problems()))
445             for problem in self.Z.resolver().problems():
446                 msger.warning("Problem: %s, %s" % (problem.description().decode("utf-8"), problem.details().decode("utf-8")))
447
448     def getLocalPkgPath(self, po):
449         repoinfo = po.repoInfo()
450         cacheroot = repoinfo.packagesPath()
451         location= zypp.asKindPackage(po).location()
452         rpmpath = str(location.filename())
453         pkgpath = "%s/%s" % (cacheroot, rpmpath)
454         return pkgpath
455
456     def installLocal(self, pkg, po=None, updateonly=False):
457         if not self.ts:
458             self.__initialize_transaction()
459         solvfile = "%s/.solv" % (self.cachedir)
460         rc, out = runner.runtool([fs_related.find_binary_path("rpms2solv"), pkg])
461         if rc == 0:
462             f = open(solvfile, "w+")
463             f.write(out)
464             f.close()
465             warnmsg = self.repo_manager.loadSolvFile(solvfile , os.path.basename(pkg))
466             if warnmsg:
467                 msger.warning(warnmsg)
468             os.unlink(solvfile)
469         else:
470             msger.warning('Can not get %s solv data.' % pkg)
471         hdr = rpmmisc.readRpmHeader(self.ts, pkg)
472         arch = zypp.Arch(hdr['arch'])
473         sysarch = zypp.Arch(self.target_arch)
474         if arch.compatible_with (sysarch):
475             pkgname = hdr['name']
476             self.localpkgs[pkgname] = pkg
477             self.selectPackage(pkgname)
478             msger.info("Marking %s to be installed" % (pkg))
479         else:
480             msger.warning ("Cannot add package %s to transaction. Not a compatible architecture: %s" % (pkg, hdr['arch']))
481
482     def downloadPkgs(self, package_objects, count):
483         localpkgs = self.localpkgs.keys()
484         progress_obj = rpmmisc.TextProgress(count)
485         for po in package_objects:
486             if po.name() in localpkgs:
487                 continue
488             filename = self.getLocalPkgPath(po)
489             if os.path.exists(filename):
490                 if self.checkPkg(filename) == 0:
491                     continue
492             dirn = os.path.dirname(filename)
493             if not os.path.exists(dirn):
494                 os.makedirs(dirn)
495             baseurl = str(po.repoInfo().baseUrls()[0])
496             index = baseurl.find("?")
497             if index > -1:
498                 baseurl = baseurl[:index]
499             proxy = self.get_proxy(po.repoInfo())
500             proxies = {}
501             if proxy:
502                 proxies = {str(proxy.split(":")[0]):str(proxy)}
503
504             location = zypp.asKindPackage(po).location()
505             location = str(location.filename())
506             if location.startswith("./"):
507                 location = location[2:]
508             url = baseurl + "/%s" % location
509             try:
510                 filename = rpmmisc.myurlgrab(url, filename, proxies, progress_obj)
511             except CreatorError:
512                 self.close()
513                 raise
514
515     def installPkgs(self, package_objects):
516         if not self.ts:
517             self.__initialize_transaction()
518
519         """ Set filters """
520         probfilter = 0
521         for flag in self.probFilterFlags:
522             probfilter |= flag
523         self.ts.setProbFilter(probfilter)
524
525         localpkgs = self.localpkgs.keys()
526         for po in package_objects:
527             pkgname = po.name()
528             if pkgname in localpkgs:
529                 rpmpath = self.localpkgs[pkgname]
530             else:
531                 rpmpath = self.getLocalPkgPath(po)
532             if not os.path.exists(rpmpath):
533                 """ Maybe it is a local repo """
534                 baseurl = str(po.repoInfo().baseUrls()[0])
535                 baseurl = baseurl.strip()
536                 location = zypp.asKindPackage(po).location()
537                 location = str(location.filename())
538                 if baseurl.startswith("file:/"):
539                     rpmpath = baseurl[5:] + "/%s" % (location)
540             if not os.path.exists(rpmpath):
541                 raise RpmError("Error: %s doesn't exist" % rpmpath)
542             h = rpmmisc.readRpmHeader(self.ts, rpmpath)
543             self.ts.addInstall(h, rpmpath, 'u')
544
545         unresolved_dependencies = self.ts.check()
546         if not unresolved_dependencies:
547             self.ts.order()
548             cb = rpmmisc.RPMInstallCallback(self.ts)
549             installlogfile = "%s/__catched_stderr.buf" % (self.instroot)
550             msger.enable_logstderr(installlogfile)
551             errors = self.ts.run(cb.callback, '')
552             if errors is None:
553                 pass
554             elif len(errors) == 0:
555                 msger.warning('scriptlet or other non-fatal errors occurred during transaction.')
556             else:
557                 for e in errors:
558                     msger.warning(e[0])
559                 msger.error('Could not run transaction.')
560             msger.disable_logstderr()
561
562             self.ts.closeDB()
563             self.ts = None
564         else:
565             for pkg, need, needflags, sense, key in unresolved_dependencies:
566                 package = '-'.join(pkg)
567                 if needflags == rpm.RPMSENSE_LESS:
568                     deppkg = ' < '.join(need)
569                 elif needflags == rpm.RPMSENSE_EQUAL:
570                     deppkg = ' = '.join(need)
571                 elif needflags == rpm.RPMSENSE_GREATER:
572                     deppkg = ' > '.join(need)
573                 else:
574                     deppkg = '-'.join(need)
575
576                 if sense == rpm.RPMDEP_SENSE_REQUIRES:
577                     msger.warning ("[%s] Requires [%s], which is not provided" % (package, deppkg))
578                 elif sense == rpm.RPMDEP_SENSE_CONFLICTS:
579                     msger.warning ("[%s] Conflicts with [%s]" % (package, deppkg))
580
581             raise RepoError("Unresolved dependencies, transaction failed.")
582
583     def __initialize_transaction(self):
584         if not self.ts:
585             self.ts = rpm.TransactionSet(self.instroot)
586             # Set to not verify DSA signatures.
587             self.ts.setVSFlags(rpm._RPMVSF_NOSIGNATURES|rpm._RPMVSF_NODIGESTS)
588
589     def checkPkg(self, pkg):
590         ret = 1
591         if not os.path.exists(pkg):
592             return ret
593         ret = rpmmisc.checkRpmIntegrity('rpm', pkg)
594         if ret != 0:
595             msger.warning("package %s is damaged: %s" % (os.path.basename(pkg), pkg))
596
597         return ret
598
599     def _add_prob_flags(self, *flags):
600         for flag in flags:
601            if flag not in self.probFilterFlags:
602                self.probFilterFlags.append(flag)
603
604     def get_proxy(self, repoinfo):
605         proxy = None
606         reponame = "%s" % repoinfo.name()
607         for repo in self.repos:
608             if repo.name == reponame:
609                 proxy = repo.proxy
610                 break
611
612         if proxy:
613             return proxy
614         else:
615             repourl = str(repoinfo.baseUrls()[0])
616             return get_proxy_for(repourl)