MediaCD.cc

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#include <iostream>

#include "zypp/base/Logger.h"
#include "zypp/ExternalProgram.h"
#include "zypp/media/Mount.h"
#include "zypp/media/MediaCD.h"
#include "zypp/media/MediaManager.h"
#include "zypp/Url.h"
#include "zypp/target/hal/HalContext.h"

#include <cstring> // strerror
#include <cstdlib> // getenv

#include <errno.h>
#include <dirent.h>

#include <sys/ioctl.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h> // geteuid, ...

#include <linux/cdrom.h>

/*
** verify devices names as late as possible (while attach)
*/
#define  DELAYED_VERIFY          1

/*
** try umount of foreign (user/automounter) media on eject
**   0 = don't force, 1 = automounted only, 2 == all
*/
#define  FORCE_RELEASE_FOREIGN   1

/*
** if to throw exception on eject errors or ignore them
*/
#define  REPORT_EJECT_ERRORS     1

using namespace std;

namespace zypp {
  namespace media {

    namespace {

      bool isNewDevice(const std::list<MediaSource> &devices,
                       const MediaSource            &media)
      {
        std::list<MediaSource>::const_iterator d( devices.begin());
        for( ; d != devices.end(); ++d)
        {
          if( media.equals( *d))
            return false;
        }
        return true;
      }

      inline Pathname get_sysfs_path()
      {
        Pathname sysfs_path;
        if(::getuid() == ::geteuid() && ::getgid() == ::getegid())
        {
          const char *env = ::getenv("SYSFS_PATH");
          if( env && *env)
          {
            sysfs_path = env;
            if( PathInfo(sysfs_path, PathInfo::LSTAT).isDir())
              return sysfs_path;
          }
        }
        sysfs_path = "/sys";
        if( PathInfo(sysfs_path, PathInfo::LSTAT).isDir())
          return sysfs_path;
        else
          return Pathname();
      }

    }


//
//      CLASS NAME : MediaCD
//

    //
    //
    //  METHOD NAME : MediaCD::MediaCD
    //  METHOD TYPE : Constructor
    //
    //  DESCRIPTION :
    //
    MediaCD::MediaCD( const Url &      url_r,
                  const Pathname & attach_point_hint_r )
      : MediaHandler( url_r, attach_point_hint_r,
                    url_r.getPathName(), // urlpath below attachpoint
                    false )
      //, does_download
      , _lastdev(-1)
    {
      MIL << "MediaCD::MediaCD(" << url_r << ", "
          << attach_point_hint_r << ")" << endl;

      if( url_r.getScheme() != "dvd" && url_r.getScheme() != "cd")
      {
        ERR << "Unsupported schema in the Url: " << url_r.asString()
                                                 << std::endl;
        ZYPP_THROW(MediaUnsupportedUrlSchemeException(_url));
      }

#if !DELAYED_VERIFY
      DeviceList detected( detectDevices(
        url_r.getScheme() == "dvd" ? true : false
      ));
#endif

      string devices = _url.getQueryParam("devices");
      if (!devices.empty())
      {
        string::size_type pos;
        DBG << "parse " << devices << endl;
        while(!devices.empty())
        {
            pos = devices.find(',');
            string device = devices.substr(0,pos);
            if (!device.empty())
            {
#if DELAYED_VERIFY
              MediaSource media("cdrom", device, 0, 0);
              _devices.push_back( media);
               DBG << "use device (delayed verify)" << device << endl;
#else
              bool is_ok = false;
              PathInfo dinfo(device);
              if( dinfo.isBlk())
              {
                MediaSource media("cdrom", device, dinfo.major(),
                                                   dinfo.minor());
                DeviceList::const_iterator d( detected.begin());
                for( ; d != detected.end(); ++d)
                {
                  if( media.equals( *d))
                  {
                    is_ok = true;
                    _devices.push_back( *d);
                    DBG << "use device " << device << endl;
                  }
                }
              }

              if( !is_ok)
              {
                ERR << "Device " << device << " is not acceptable "
                    << "for " << _url.getScheme() << std::endl;
                ZYPP_THROW(MediaBadUrlException(_url,
                  "Invalid device name in URL devices argument"
                ));
              }
#endif
            }
            if (pos!=string::npos)
                devices=devices.substr(pos+1);
            else
                devices.erase();
        }
      }
      else
      {
#if DELAYED_VERIFY
        DBG << "going to use on-demand device list" << endl;
        return;
#else
        DBG << "going to use default device list" << endl;
        //default is /dev/cdrom; for dvd: /dev/dvd if it exists
        string device( "/dev/cdrom" );
        if ( _url.getScheme() == "dvd" && PathInfo( "/dev/dvd" ).isBlk() ) {
          device = "/dev/dvd";
        }

        PathInfo dinfo(device);
        if( dinfo.isBlk())
        {
          MediaSource media("cdrom", device, dinfo.major(), dinfo.minor());

          DeviceList::const_iterator d( detected.begin());
          for( ; d != detected.end(); ++d)
          {
            // /dev/cdrom or /dev/dvd to the front
            if( media.equals( *d))
              _devices.push_front( *d);
            else
              _devices.push_back( *d);
          }
        }
        else
        {
          // no /dev/cdrom or /dev/dvd link
          _devices = detected;
        }
#endif
      }

      if( _devices.empty())
      {
        ERR << "Unable to find any cdrom drive for " << _url.asString()
                                                     << std::endl;
        ZYPP_THROW(MediaBadUrlEmptyDestinationException(_url));
      }
    }

    //
    //
    //  METHOD NAME : MediaCD::openTray
    //  METHOD TYPE : bool
    //
    bool MediaCD::openTray( const string & device_r )
    {
      int fd = ::open( device_r.c_str(), O_RDONLY|O_NONBLOCK );
      if ( fd == -1 ) {
        WAR << "Unable to open '" << device_r << "' (" << ::strerror( errno ) << ")" << endl;
        return false;
      }
      int res = ::ioctl( fd, CDROMEJECT );
      ::close( fd );
      if ( res ) {
        WAR << "Eject " << device_r << " failed (" << ::strerror( errno ) << ")" << endl;
        return false;
      }
      MIL << "Eject " << device_r << endl;
      return true;
    }

    //
    //
    //  METHOD NAME : MediaCD::closeTray
    //  METHOD TYPE : bool
    //
    bool MediaCD::closeTray( const string & device_r )
    {
      int fd = ::open( device_r.c_str(), O_RDONLY|O_NONBLOCK );
      if ( fd == -1 ) {
        WAR << "Unable to open '" << device_r << "' (" << ::strerror( errno ) << ")" << endl;
        return false;
      }
      int res = ::ioctl( fd, CDROMCLOSETRAY );
      ::close( fd );
      if ( res ) {
        WAR << "Close tray " << device_r << " failed (" << ::strerror( errno ) << ")" << endl;
        return false;
      }
      DBG << "Close tray " << device_r << endl;
      return true;
    }

    //
    //
    //  METHOD NAME : MediaCD::detectDevices
    //  METHOD TYPE : MediaCD::DeviceList
    //
    MediaCD::DeviceList
    MediaCD::detectDevices(bool supportingDVD)
    {
      using namespace zypp::target::hal;

      DeviceList detected;
      try
      {
        HalContext hal(true);

        std::vector<std::string> drv_udis;
        drv_udis = hal.findDevicesByCapability("storage.cdrom");

        DBG << "Found " << drv_udis.size() << " cdrom drive udis" << std::endl;
        for(size_t d = 0; d < drv_udis.size(); d++)
        {
          HalDrive drv( hal.getDriveFromUDI( drv_udis[d]));

          if( drv)
          {
            if( supportingDVD)
            {
              std::vector<std::string> caps;
              try {
                caps = drv.getCdromCapabilityNames();
              }
              catch(const HalException &e)
              {
                ZYPP_CAUGHT(e);
              }

              bool found=false;
              std::vector<std::string>::const_iterator ci;
              for( ci=caps.begin(); ci != caps.end(); ++ci)
              {
                if( *ci == "dvd")
                  found = true;
              }
              if( !found)
                continue;
            }

            MediaSource media("cdrom", drv.getDeviceFile(),
                                       drv.getDeviceMajor(),
                                       drv.getDeviceMinor());
            DBG << "Found " << drv_udis[d] << ": "
                            << media.asString() << std::endl;
            detected.push_back(media);
          }
        }
      }
      catch(const zypp::target::hal::HalException &e)
      {
        ZYPP_CAUGHT(e);
      }

      //
      // Bug #163971
      // Hal does not include SCSI / Virtual CDROMs on iSeries ...
      //
      // Hmm... always? We can't detect DVD here.
      if( detected.empty())
      {
        Pathname    sysfs_path( get_sysfs_path());
        if(sysfs_path.empty())
          return detected;

        std::string sys_name;
        std::string dev_name;

        // SCSI cdrom devices (/dev/sr0, ...)
        sys_name = sysfs_path.cat("block/sr").asString();
        dev_name = "/dev/sr";
        DBG << "Collecting SCSI CD-ROM devices ("
            << dev_name << "X)" << std::endl;
        for(size_t i=0; i < 16; i++)
        {
          PathInfo sys_info(sys_name + str::numstring(i));
          PathInfo dev_info(dev_name + str::numstring(i));
          if( sys_info.isDir() && dev_info.isBlk())
          {
            // Hmm.. how to check if it supports DVDs?
            MediaSource media("cdrom", dev_info.asString(),
                                       dev_info.major(),
                                       dev_info.minor());
            if( isNewDevice(detected, media))
            {
              DBG << "Found SCSI CDROM "
                  << media.asString()
                  << std::endl;
              detected.push_back(media);
            }
          }
        }

        // IBM iSeries virtual CD-ROM devices (how many?)
#if powerpc
        sys_name = sysfs_path.cat("block/iseries!vcd").asString();
        dev_name = "/dev/iseries/vcd";
        DBG << "Collecting iSeries virtual CD-ROM devices ("
            << dev_name << "X)" << std::endl;
        for(size_t i=0; i < 8; i++)
        {
          char drive_letter = 'a' + i;
          PathInfo sys_info(sys_name + drive_letter);
          PathInfo dev_info(dev_name + drive_letter);
          if( sys_info.isDir() && dev_info.isBlk())
          {
            // Hmm.. how to check if it supports DVDs?
            MediaSource media("cdrom", dev_info.asString(),
                                       dev_info.major(),
                                       dev_info.minor());
            if( isNewDevice(detected, media))
            {
              DBG << "Found iSeries virtual CDROM "
                  << media.asString()
                  << std::endl;
              detected.push_back(media);
            }
          }
        }
#endif // powerpc

        // Other device types?
      }
      return detected;
    }


    //
    //
    //  METHOD NAME : MediaCD::attachTo
    //  METHOD TYPE : PMError
    //
    //  DESCRIPTION : Asserted that not already attached, and attachPoint is a directory.
    //
    void MediaCD::attachTo(bool next)
    {
      DBG << "next " << next << " last " << _lastdev << endl;
      if (next && _lastdev == -1)
        ZYPP_THROW(MediaNotSupportedException(url()));

#if DELAYED_VERIFY
      DeviceList detected( detectDevices(
        _url.getScheme() == "dvd" ? true : false
      ));

      if(_devices.empty())
      {
        DBG << "creating on-demand device list" << endl;
        //default is /dev/cdrom; for dvd: /dev/dvd if it exists
        string device( "/dev/cdrom" );
        if ( _url.getScheme() == "dvd" && PathInfo( "/dev/dvd" ).isBlk() ) {
          device = "/dev/dvd";
        }

        PathInfo dinfo(device);
        if( dinfo.isBlk())
        {
          MediaSource media("cdrom", device, dinfo.major(), dinfo.minor());

          DeviceList::const_iterator d( detected.begin());
          for( ; d != detected.end(); ++d)
          {
            // /dev/cdrom or /dev/dvd to the front
            if( media.equals( *d))
              _devices.push_front( *d);
            else
              _devices.push_back( *d);
          }
        }
        else
        {
          // no /dev/cdrom or /dev/dvd link
          _devices = detected;
        }
      }
#endif

      Mount mount;
      string mountpoint = attachPoint().asString();
      bool mountsucceeded = false;
      int count = 0;

      string options = _url.getQueryParam("mountoptions");
      if (options.empty())
      {
        options="ro";
      }
    
      //TODO: make configurable
      list<string> filesystems;
    
      // if DVD, try UDF filesystem before iso9660
      if ( _url.getScheme() == "dvd" )
        filesystems.push_back("udf");
    
      filesystems.push_back("iso9660");
    
      // try all devices in sequence
      for (DeviceList::iterator it = _devices.begin()
        ; !mountsucceeded && it != _devices.end()
        ; ++it, count++ )
      {
        DBG << "count " << count << endl;
        if (next && count<=_lastdev )
        {
                DBG << "skipping device " << it->name << endl;
                continue;
        }
#if DELAYED_VERIFY
        MediaSource temp( *it);
        bool        valid=false;
        PathInfo    dinfo(temp.name);
        if( dinfo.isBlk())
        {
          temp.maj_nr = dinfo.major();
          temp.min_nr = dinfo.minor();

          DeviceList::const_iterator d( detected.begin());
          for( ; d != detected.end(); ++d)
          {
            if( temp.equals( *d))
            {
              valid = true;
              break;
            }
          }
        }
        if( !valid)
        {
                DBG << "skipping invalid device: " << it->name << endl;
                continue;
        }
        MediaSourceRef media( new MediaSource(temp));
#else
        MediaSourceRef media( new MediaSource( *it));
#endif

        AttachedMedia ret( findAttachedMedia( media));

        if( ret.mediaSource && ret.attachPoint &&
           !ret.attachPoint->empty())
        {
          DBG << "Using a shared media "
              << ret.mediaSource->name
              << " attached on "
              << ret.attachPoint->path
              << endl;
          removeAttachPoint();
          setAttachPoint(ret.attachPoint);
          setMediaSource(ret.mediaSource);
          _lastdev = count;
          mountsucceeded = true;
          break;
        }
        // FIXME: hmm... we may also
        // - check against hal/mtab if still mounted
        // - if !ret, check if already mounted (e.g.
        //   by automounter) and reuse (!temp) ?

        // close tray
        closeTray( it->name );

        // try all filesystems in sequence
        for(list<string>::iterator fsit = filesystems.begin()
            ; !mountsucceeded && fsit != filesystems.end()
            ; ++fsit)
        {
          try {
            if( !isUseableAttachPoint(Pathname(mountpoint)))
            {
              mountpoint = createAttachPoint().asString();
              setAttachPoint( mountpoint, true);
              if( mountpoint.empty())
              {
                ZYPP_THROW( MediaBadAttachPointException(url()));
              }
            }

            mount.mount(it->name, mountpoint, *fsit, options);

            setMediaSource(media);

            // wait for /etc/mtab update ...
            // (shouldn't be needed)
            int limit = 3;
            while( !(mountsucceeded=isAttached()) && --limit)
            {
              sleep(1);
            }

            if( mountsucceeded)
            {
              _lastdev = count;
            }
            else
            {
              setMediaSource(MediaSourceRef());
              try
              {
                mount.umount(attachPoint().asString());
              }
              catch (const MediaException & excpt_r)
              {
                ZYPP_CAUGHT(excpt_r);
              }
              ZYPP_THROW(MediaMountException(
                "Unable to verify that the media was mounted",
                it->name, mountpoint
              ));
            }
          }
          catch (const MediaException & excpt_r)
          {
            removeAttachPoint();
            ZYPP_CAUGHT(excpt_r);
          }
        }
      }
    
      if (!mountsucceeded)
      {
        _lastdev = -1;
        ZYPP_THROW(MediaMountException(_url.asString(), mountpoint, "Mounting media failed"));
      }
      DBG << _lastdev << " " << count << endl;
    }


    //
    //
    //  METHOD NAME : MediaCD::releaseFrom
    //  METHOD TYPE : PMError
    //
    //  DESCRIPTION : Asserted that media is attached.
    //
    void MediaCD::releaseFrom( bool eject )
    {
      Mount mount;
      try {
        mount.umount(attachPoint().asString());
      }
      catch (const Exception & excpt_r)
      {
        ZYPP_CAUGHT(excpt_r);
        if (eject)
        {
#if FORCE_RELEASE_FOREIGN
          forceRelaseAllMedia(false, FORCE_RELEASE_FOREIGN != 2);
#endif
          if(openTray( mediaSourceName()))
            return;
        }
        ZYPP_RETHROW(excpt_r);
      }
    
      // eject device
      if (eject)
      {
#if FORCE_RELEASE_FOREIGN
        forceRelaseAllMedia(false, FORCE_RELEASE_FOREIGN != 2);
#endif
        if( !openTray( mediaSourceName() ))
        {
#if REPORT_EJECT_ERRORS
          ZYPP_THROW(MediaNotEjectedException(mediaSourceName()));
#endif
        }
      }
    }

    //
    //
    //  METHOD NAME : MediaCD::forceEject
    //  METHOD TYPE : void
    //
    // Asserted that media is not attached.
    //
    void MediaCD::forceEject()
    {
      bool ejected=false;
      if ( !isAttached()) {     // no device mounted in this instance
#if DELAYED_VERIFY
        DeviceList detected( detectDevices(
          _url.getScheme() == "dvd" ? true : false
        ));

        if(_devices.empty())
        {
          DBG << "creating on-demand device list" << endl;
          //default is /dev/cdrom; for dvd: /dev/dvd if it exists
          string device( "/dev/cdrom" );
          if ( _url.getScheme() == "dvd" && PathInfo( "/dev/dvd" ).isBlk() ) {
           device = "/dev/dvd";
          }

          PathInfo dinfo(device);
          if( dinfo.isBlk())
          {
            MediaSource media("cdrom", device, dinfo.major(), dinfo.minor());

            DeviceList::const_iterator d( detected.begin());
            for( ; d != detected.end(); ++d)
            {
              // /dev/cdrom or /dev/dvd to the front
              if( media.equals( *d))
                _devices.push_front( *d);
              else
                _devices.push_back( *d);
            }
          }
          else
          {
            // no /dev/cdrom or /dev/dvd link
            _devices = detected;
          }
        }
#endif

        DeviceList::iterator it;
        for( it = _devices.begin(); it != _devices.end(); ++it ) {
          MediaSourceRef media( new MediaSource( *it));
#if DELAYED_VERIFY
          bool        valid=false;
          PathInfo    dinfo(media->name);
          if( dinfo.isBlk())
          {
            media->maj_nr = dinfo.major();
            media->min_nr = dinfo.minor();

            DeviceList::const_iterator d( detected.begin());
            for( ; d != detected.end(); ++d)
            {
              if( media->equals( *d))
              {
                valid = true;
                break;
              }
            }
          }
          if( !valid)
          {
            DBG << "skipping invalid device: " << it->name << endl;
            continue;
          }
#endif

          // FIXME: we have also to check if it is mounted in the system
          AttachedMedia ret( findAttachedMedia( media));
          if( !ret.mediaSource)
          {
#if FORCE_RELEASE_FOREIGN
            forceRelaseAllMedia(media, false, FORCE_RELEASE_FOREIGN != 2);
#endif
            if ( openTray( it->name ) )
            {
              ejected = true;
              break; // on 1st success
            }
          }
        }
      }
      if( !ejected)
      {
#if REPORT_EJECT_ERRORS
        ZYPP_THROW(MediaNotEjectedException());
#endif
      }
    }

    bool MediaCD::isAutoMountedMedia(const AttachedMedia &media)
    {
      bool is_automounted = false;
      if( media.mediaSource && !media.mediaSource->name.empty())
      {
        using namespace zypp::target::hal;

        try
        {
          HalContext hal(true);

          HalVolume vol = hal.getVolumeFromDeviceFile(media.mediaSource->name);
          if( vol)
          {
            std::string udi = vol.getUDI();
            std::string key = "info.hal_mount.created_mount_point";
            std::string mnt = hal.getDevicePropertyString(udi, key);

            if(media.attachPoint->path == mnt)
              is_automounted = true;
          }
        }
        catch(const HalException &e)
        {
          ZYPP_CAUGHT(e);
        }
      }
      DBG << "Media "       << media.mediaSource->asString()
          << " attached on " << media.attachPoint->path
          << " is"           << (is_automounted ? "" : " not")
          << " automounted"  << std::endl;
      return is_automounted;
    }

    //
    //  METHOD NAME : MediaCD::isAttached
    //  METHOD TYPE : bool
    //
    //  DESCRIPTION : Override check if media is attached.
    //
    bool
    MediaCD::isAttached() const
    {
      return checkAttached(false);
    }

    //
    //  METHOD NAME : MediaCD::getFile
    //  METHOD TYPE : PMError
    //
    //  DESCRIPTION : Asserted that media is attached.
    //
    void MediaCD::getFile( const Pathname & filename ) const
    {
      MediaHandler::getFile( filename );
    }

    //
    //  METHOD NAME : MediaCD::getDir
    //  METHOD TYPE : PMError
    //
    //  DESCRIPTION : Asserted that media is attached.
    //
    void MediaCD::getDir( const Pathname & dirname, bool recurse_r ) const
    {
      MediaHandler::getDir( dirname, recurse_r );
    }

    //
    //
    //  METHOD NAME : MediaCD::getDirInfo
    //  METHOD TYPE : PMError
    //
    //  DESCRIPTION : Asserted that media is attached and retlist is empty.
    //
    void MediaCD::getDirInfo( std::list<std::string> & retlist,
                              const Pathname & dirname, bool dots ) const
    {
      MediaHandler::getDirInfo( retlist, dirname, dots );
    }

    //
    //
    //  METHOD NAME : MediaCD::getDirInfo
    //  METHOD TYPE : PMError
    //
    //  DESCRIPTION : Asserted that media is attached and retlist is empty.
    //
    void MediaCD::getDirInfo( filesystem::DirContent & retlist,
                              const Pathname & dirname, bool dots ) const
    {
      MediaHandler::getDirInfo( retlist, dirname, dots );
    }

  } // namespace media
} // namespace zypp
// vim: set ts=8 sts=2 sw=2 ai noet:

---