sw_update.h

/*
 Copyright (C) AC SOFTWARE SP. Z O.O.
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
 
#ifndef SRC_SUPLA_DEVICE_SW_UPDATE_H_
#define SRC_SUPLA_DEVICE_SW_UPDATE_H_
 
#define SUPLA_MAX_URL_LENGTH 202
 
#include <SuplaDevice.h>
 
namespace Supla {
 
namespace Device {
class SwUpdate {
 public:
  static SwUpdate *Create(SuplaDeviceClass *sdc,
                          const char *newUrl,
                          Supla::SwUpdateMode mode);
  virtual ~SwUpdate();
 
  void start() {
    started = true;
  }
  virtual void iterate() = 0;
 
  void setUrl(const char *newUrl);
  bool isStarted() {
    return started;
  }
  bool isFinished() {
    return finished;
  }
  bool isAborted() {
    return abort;
  }
  void useBeta() {
    beta = true;
  }
  void setSkipCert() {
    // One-time recovery fallback for expired OTA certificates.
    // The OTA flow clears this mode after use.
    skipCert = true;
  }
  bool isRetryAllowed() {
    return retryAllowed;
  }
 
  const char *getUrl() const {
    return updateUrl;
  }
  const char *getNewVersion() const {
    return newVersion;
  }
  const char *getChangelogUrl() const {
    return changelogUrl;
  }
 
  bool isSecurityOnly() const {
    return securityOnly;
  }
  void setSecurityOnly() {
    securityOnly = true;
  }
 
 protected:
  explicit SwUpdate(SuplaDeviceClass *sdc,
                    const char *newUrl,
                    Supla::SwUpdateMode mode);
 
  bool beta = false;
  bool skipCert = false;
  bool securityOnly = false;
  bool started = false;
  bool finished = false;
  bool abort = false;
  SuplaDeviceClass *sdc = nullptr;
  char *updateUrl = nullptr;
  char *newVersion = nullptr;
  char *changelogUrl = nullptr;
  bool retryAllowed = false;
  Supla::SwUpdateMode mode = Supla::SwUpdateMode::NotSet;
 
  char url[SUPLA_MAX_URL_LENGTH] = {};
};
};  // namespace Device
};  // namespace Supla
 
#endif  // SRC_SUPLA_DEVICE_SW_UPDATE_H_