#include <updaterwindow.h>

Inheritance diagram for UpdaterWindow:

Public Member Functions
	UpdaterWindow (const std::string &updateHost, const std::string &updatesDir, const bool applyUpdates, const UpdateTypeT updateType)

	~UpdaterWindow ()

void	postInit ()

void	setProgress (const float p)

void	setLabel (const std::string &)

void	enable ()

void	loadNews ()

void	loadPatch ()

void	action (const ActionEvent &event)

void	keyPressed (KeyEvent &event)

void	logic ()

void	loadFile (std::string file)

void	deleteSelf ()

Public Member Functions inherited from Window
	Window (const std::string &caption, const Modal modal, Window *const parent, std::string skin)

	~Window ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	setContentSize (int width, int height)

void	setLocationRelativeTo (const Widget *const widget)

void	setLocationHorisontallyRelativeTo (const Widget *const widget)

void	setLocationRelativeTo (const ImagePosition::Type &position, int offsetX, int offsetY)

void	setResizable (const bool resize)

void	redraw ()

void	widgetResized (const Event &event)

void	widgetMoved (const Event &event)

void	widgetHidden (const Event &event)

void	setCloseButton (const bool flag)

bool	getCloseButton () const

void	setAllowClose (const bool b)

bool	getAlowClose () const

bool	isResizable () const

void	setMinWidth (const int width)

int	getMinWidth () const

void	setMinHeight (const int height)

int	getMinHeight () const

void	setMaxWidth (const int width)

int	getMaxWidth () const

void	setMaxHeight (const int height)

int	getMaxHeight () const

void	setShowTitle (bool flag)

void	setStickyButton (const bool flag)

void	setSticky (const bool sticky)

bool	isSticky () const

void	setStickyButtonLock (const bool sticky)

bool	isStickyButtonLock () const

virtual void	setVisible (Visible visible)

void	setVisible (const Visible visible, const bool forceSticky)

bool	isDefaultVisible () const

void	setDefaultVisible (const bool save)

bool	willSaveVisible () const

void	setSaveVisible (const bool save)

Window *	getParentWindow () const

virtual void	scheduleDelete ()

void	mousePressed (MouseEvent &event)

void	mouseDragged (MouseEvent &event)

void	mouseMoved (MouseEvent &event)

void	mouseReleased (MouseEvent &event)

void	mouseExited (MouseEvent &event)

void	mouseEntered (MouseEvent &event)

void	updateResizeHandler (MouseEvent &event)

void	setWindowName (const std::string &name)

const std::string &	getWindowName () const

void	loadWindowState ()

void	saveWindowState ()

void	setDefaultSize (const int defaultX, const int defaultY, int defaultWidth, int defaultHeight)

void	setDefaultSize ()

void	setDefaultSize (const int defaultWidth, const int defaultHeight, const ImagePosition::Type &position, const int offsetx, const int offsetY)

virtual void	resetToDefaultSize ()

void	adjustPositionAfterResize (const int oldScreenWidth, const int oldScreenHeight)

Layout &	getLayout ()

void	clearLayout ()

void	reflowLayout (int w, int h)

LayoutCell &	place (const int x, const int y, Widget *const wg, const int w, const int h)

ContainerPlacer	getPlacer (const int x, const int y)

void	center ()

void	centerHorisontally ()

virtual void	close ()

void	setModal (const Modal modal)

Rect	getWindowArea () const

bool	isResizeAllowed (const MouseEvent &event) const

void	setCaptionFont (Font *font)

void	enableVisibleSound (bool b)

bool	isWindowVisible () const

void	setPadding (int padding)

int	getPadding () const

void	setTitleBarHeight (unsigned int height)

unsigned int	getTitleBarHeight () const

void	setCaption (const std::string &caption)

const std::string &	getCaption () const

void	setAlignment (Graphics::Alignment alignment)

Graphics::Alignment	getAlignment () const

void	setMovable (Move movable)

bool	isMovable () const

Rect	getChildrenArea ()

virtual void	resizeToContent ()

Public Member Functions inherited from BasicContainer2
	BasicContainer2 (const Widget2 *const widget)

	~BasicContainer2 ()

void	setOpaque (Opaque opaque)

bool	isOpaque () const

virtual void	add (Widget *const widget)

void	addXY (Widget *const widget, const int x, const int y)

Public Member Functions inherited from BasicContainer
	BasicContainer (const Widget2 *const widget)

	~BasicContainer ()

void	showWidgetPart (Widget *const widget, const Rect &area)

void	moveToTop (Widget *const widget)

void	moveToBottom (Widget *const widget)

void	focusNext ()

void	focusPrevious ()

void	setFocusHandler (FocusHandler *const focusHandler)

void	setInternalFocusHandler (FocusHandler *const focusHandler)

Widget *	getWidgetAt (int x, int y)

void	death (const Event &event)

Widget *	findFirstWidget (const std::set< Widget * > &list)

void	add (Widget *const widget)

virtual void	remove (Widget *const widget)

virtual void	clear ()

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Public Member Functions inherited from WidgetDeathListener
virtual	~WidgetDeathListener ()

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

virtual void	mouseClicked (MouseEvent &event)

virtual void	mouseWheelMovedUp (MouseEvent &event)

virtual void	mouseWheelMovedDown (MouseEvent &event)

Public Member Functions inherited from WidgetListener
virtual	~WidgetListener ()

virtual void	widgetShown (const Event &event)

Public Member Functions inherited from ActionListener
virtual	~ActionListener ()

Public Member Functions inherited from KeyListener
virtual	~KeyListener ()

virtual void	keyReleased (KeyEvent &event)

Static Public Member Functions
static void	loadLocalUpdates (const std::string &dir)

static void	unloadUpdates (const std::string &dir)

static void	addUpdateFile (const std::string &path, const std::string &fixPath, const std::string &file, const Append append)

static void	removeUpdateFile (const std::string &path, const std::string &fixPath, const std::string &filerestrict)

static void	loadManaPlusUpdates (const std::string &dir)

static void	unloadManaPlusUpdates (const std::string &dir)

static unsigned long	getFileHash (const std::string &filePath)

static void	loadMods (const std::string &dir, const std::vector< UpdateFile > &updateFiles)

static void	loadDirMods (const std::string &dir)

static void	unloadMods (const std::string &dir)

Static Public Member Functions inherited from Window
static void	setWindowContainer (WindowContainer *const windowContainer)

Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Private Member Functions
void	download ()

void	loadUpdates ()

Static Private Member Functions
static int	updateProgress (void *ptr, const DownloadStatusT status, size_t dt, const size_t dn)

static size_t	memoryWrite (void ptr, size_t size, size_t nmemb, void stream)

static bool	validateFile (const std::string &filePath, const unsigned long hash)

Private Attributes
float	mDownloadProgress

std::string	mUpdateHost

std::string	mUpdatesDir

std::string	mUpdatesDirReal

std::string	mCurrentFile

std::string	mNewLabelCaption

Mutex	mDownloadMutex

unsigned long	mCurrentChecksum

char *	mMemoryBuffer

Net::Download *	mDownload

std::vector< UpdateFile >	mUpdateFiles

std::vector< UpdateFile >	mTempUpdateFiles

std::string	mUpdateServerPath

ItemLinkHandler *	mItemLinkHandler

Label *	mLabel

Button *	mCancelButton

Button *	mPlayButton

ProgressBar *	mProgressBar

StaticBrowserBox *	mBrowserBox

ScrollArea *	mScrollArea

UpdateDownloadStatusT	mDownloadStatus

int	mDownloadedBytes

unsigned int	mUpdateIndex

unsigned int	mUpdateIndexOffset

UpdateTypeT	mUpdateType

bool	mStoreInMemory

bool	mDownloadComplete

bool	mUserCancel

bool	mLoadUpdates

bool	mValidateXml

bool	mSkipPatches

Additional Inherited Members
Data Fields inherited from Widget
Visible	mVisible

Protected Types inherited from BasicContainer
typedef std::vector< Widget * >	WidgetList

typedef WidgetList::iterator	WidgetListIterator

typedef WidgetList::const_iterator	WidgetListConstIterator

typedef WidgetList::reverse_iterator	WidgetListReverseIterator

typedef WidgetList::const_reverse_iterator	WidgetListCReverseIterator

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Member Functions inherited from Window
bool	canMove () const

int	getOption (const std::string &name, const int def) const

bool	getOptionBool (const std::string &name, const bool def) const

void	setTitlePadding (const int p)

int	getTitlePadding () const

Protected Member Functions inherited from BasicContainer
virtual void	drawChildren (Graphics *const graphics)

virtual void	safeDrawChildren (Graphics *const graphics)

virtual void	logicChildren ()

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Member Functions inherited from WidgetDeathListener
	WidgetDeathListener ()

Protected Member Functions inherited from MouseListener
	MouseListener ()

Protected Member Functions inherited from WidgetListener
	WidgetListener ()

Protected Member Functions inherited from ActionListener
	ActionListener ()

Protected Member Functions inherited from KeyListener
	KeyListener ()

Protected Attributes inherited from Window
std::string	mCaption

Graphics::Alignment	mAlignment

int	mPadding

unsigned int	mTitleBarHeight

Move	mMovable

int	mDragOffsetX

int	mDragOffsetY

bool	mMoved

Skin *	mSkin

int	mDefaultX

int	mDefaultY

int	mDefaultWidth

int	mDefaultHeight

int	mCaptionOffsetX

int	mCaptionOffsetY

bool	mShowTitle

bool	mLastRedraw

Protected Attributes inherited from BasicContainer2
Opaque	mOpaque

Protected Attributes inherited from BasicContainer
WidgetList	mWidgets

WidgetList	mLogicWidgets

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

Update progress window GUI

Definition at line 60 of file updaterwindow.h.

Constructor & Destructor Documentation

◆ UpdaterWindow()

UpdaterWindow::UpdaterWindow	(	const std::string &	updateHost,
		const std::string &	updatesDir,
		const bool	applyUpdates,
		const UpdateTypeT	updateType
	)

Constructor.

Parameters

updateHost	Host where to get the updated files.
updatesDir	Directory where to store updates (should be absolute and already created).
applyUpdates	If true, the update window will pass the updates to teh resource manager.

Definition at line 170 of file updaterwindow.cpp.

  :
  // TRANSLATORS: updater window name
  Window(_("Updating..."), Modal_false, nullptr, "update.xml"),
  ActionListener(),
  KeyListener(),
  mDownloadProgress(0.0F),
  mUpdateHost(updateHost),
  mUpdatesDir(updatesDir),
  mUpdatesDirReal(updatesDir),
  mCurrentFile("news.txt"),
  mNewLabelCaption(),
  mDownloadMutex(),
  mCurrentChecksum(0),
  mMemoryBuffer(nullptr),
  mDownload(nullptr),
  mUpdateFiles(),
  mTempUpdateFiles(),
  mUpdateServerPath(mUpdateHost),
  mItemLinkHandler(new ItemLinkHandler),
  // TRANSLATORS: updater window label
  mLabel(new Label(this, _("Connecting..."))),
  // TRANSLATORS: updater window button
  mCancelButton(new Button(this, _("Cancel"), "cancel", BUTTON_SKIN, this)),
  // TRANSLATORS: updater window button
  mPlayButton(new Button(this, _("Play"), "play", BUTTON_SKIN, this)),
  mProgressBar(new ProgressBar(this, 0.0, 310, 0,
  ProgressColorId::PROG_UPDATE,
  "updateprogressbar.xml", "updateprogressbar_fill.xml")),
  mBrowserBox(new StaticBrowserBox(this, Opaque_true,
  "browserbox.xml")),
  mScrollArea(new ScrollArea(this, mBrowserBox,
  Opaque_true, "update_background.xml")),
  mDownloadStatus(UpdateDownloadStatus::UPDATE_NEWS),
  mDownloadedBytes(0),
  mUpdateIndex(0),
  mUpdateIndexOffset(0),
  mUpdateType(updateType),
  mStoreInMemory(true),
  mDownloadComplete(true),
  mUserCancel(false),
  mLoadUpdates(applyUpdates),
  mValidateXml(false),
  mSkipPatches(false)
 {
  setWindowName("UpdaterWindow");
  setResizable(true);
  setDefaultSize(450, 400, ImagePosition::CENTER, 0, 0);
  setMinWidth(310);
  setMinHeight(220);
  
  mProgressBar->setSmoothProgress(false);
  mBrowserBox->setOpaque(Opaque_false);
  mBrowserBox->setLinkHandler(mItemLinkHandler);
  mBrowserBox->setProcessVars(true);
  mBrowserBox->setEnableKeys(true);
  mBrowserBox->setEnableTabs(true);
  mBrowserBox->setEnableImages(true);
  mPlayButton->setEnabled(false);
  
  ContainerPlacer placer(nullptr, nullptr);
  placer = getPlacer(0, 0);
  
  placer(0, 0, mScrollArea, 5, 3).setPadding(3);
  placer(0, 3, mLabel, 5, 1);
  placer(0, 4, mProgressBar, 5, 1);
  placer(3, 5, mCancelButton, 1, 1);
  placer(4, 5, mPlayButton, 1, 1);
  
  Layout &layout = getLayout();
  layout.setRowHeight(0, LayoutType::SET);
  
  addKeyListener(this);
  
  if (mUpdateHost.empty())
  {
  const STD_VECTOR<std::string> &mirrors = settings.updateMirrors;
  if (mirrors.begin() != mirrors.end())
  mUpdateHost = *mirrors.begin();
  mSkipPatches = true;
  }
  
  loadWindowState();
 }

References Widget::addKeyListener(), ImagePosition::CENTER, Window::getLayout(), Window::getPlacer(), Window::loadWindowState(), mBrowserBox, mCancelButton, mItemLinkHandler, mLabel, mPlayButton, mProgressBar, mScrollArea, mSkipPatches, mUpdateHost, Opaque_false, LayoutType::SET, Window::setDefaultSize(), Widget::setEnabled(), StaticBrowserBox::setEnableImages(), StaticBrowserBox::setEnableKeys(), StaticBrowserBox::setEnableTabs(), StaticBrowserBox::setLinkHandler(), Window::setMinHeight(), Window::setMinWidth(), StaticBrowserBox::setOpaque(), StaticBrowserBox::setProcessVars(), Window::setResizable(), LayoutCell::setRowHeight(), ProgressBar::setSmoothProgress(), settings, Window::setWindowName(), and Settings::updateMirrors.

◆ ~UpdaterWindow()

UpdaterWindow::~UpdaterWindow ( )

Destructor

Definition at line 267 of file updaterwindow.cpp.

 {
  if (mLoadUpdates)
  loadUpdates();
  
  if (mDownload != nullptr)
  {
  mDownload->cancel();
  
  delete2(mDownload)
  }
  free(mMemoryBuffer);
  delete2(mItemLinkHandler)
 }

References Net::Download::cancel, delete2, loadUpdates(), mDownload, mItemLinkHandler, mLoadUpdates, and mMemoryBuffer.

Member Function Documentation

◆ action()

void UpdaterWindow::action ( const ActionEvent & actionEvent )

virtual

Called when an action is recieved from a widget. It is used to be able to recieve a notification that an action has occured.

Parameters

actionEvent The event of the action.

Implements ActionListener.

Definition at line 313 of file updaterwindow.cpp.

 {
  const std::string &eventId = event.getId();
  if (eventId == "cancel")
  {
  // Register the user cancel
  mUserCancel = true;
  // Skip the updating process
  if (mDownloadStatus != UpdateDownloadStatus::UPDATE_COMPLETE)
  {
  if (mDownload != nullptr)
  mDownload->cancel();
  mDownloadStatus = UpdateDownloadStatus::UPDATE_ERROR;
  }
  }
  else if (eventId == "play")
  {
  if (client->getState() != State::GAME)
  client->setState(State::LOAD_DATA);
  else
  deleteSelf();
  }
 }

References Net::Download::cancel, client, deleteSelf(), State::GAME, Client::getState(), State::LOAD_DATA, mDownload, mDownloadStatus, mUserCancel, Client::setState(), UpdateDownloadStatus::UPDATE_COMPLETE, and UpdateDownloadStatus::UPDATE_ERROR.

Referenced by keyPressed().

◆ addUpdateFile()

void UpdaterWindow::addUpdateFile	(	const std::string &	path,
		const std::string &	fixPath,
		const std::string &	file,
		const Append	append
	)

static

Definition at line 800 of file updaterwindow.cpp.

 {
  const std::string tmpPath = pathJoin(path, file);
  if (append == Append_false)
  VirtFs::mountZip(tmpPath, append);
  
  const std::string fixFile = pathJoin(fixPath, file);
  struct stat statbuf;
  if (stat(fixFile.c_str(), &statbuf) == 0)
  VirtFs::mountZip(fixFile, append);
  
  if (append == Append_true)
  VirtFs::mountZip(tmpPath, append);
 }

References Append_false, Append_true, VirtFs::mountZip(), and pathJoin().

Referenced by loadLocalUpdates(), loadMods(), and loadUpdates().

◆ deleteSelf()

void UpdaterWindow::deleteSelf ( )

Definition at line 1220 of file updaterwindow.cpp.

 {
  scheduleDelete();
  updaterWindow = nullptr;
 }

References Window::scheduleDelete(), and updaterWindow.

Referenced by action(), enable(), and keyPressed().

◆ download()

void UpdaterWindow::download ( )

private

Definition at line 581 of file updaterwindow.cpp.

 {
  if (mDownload != nullptr)
  {
  mDownload->cancel();
  delete mDownload;
  }
  if (mDownloadStatus == UpdateDownloadStatus::UPDATE_PATCH)
  {
  mDownload = new Net::Download(this,
  branding.getStringValue("updateMirror1") + mCurrentFile,
  &updateProgress,
  true, false, mValidateXml);
  for (int f = 2; f < 8; f ++)
  {
  const std::string url = branding.getStringValue(
  "updateMirror" + toString(f));
  if (!url.empty())
  mDownload->addMirror(url + mCurrentFile);
  }
  }
  else
  {
  mDownload = new Net::Download(this,
  urlJoin(mUpdateHost, mCurrentFile),
  &updateProgress,
  false, false, mValidateXml);
  
  if (mDownloadStatus == UpdateDownloadStatus::UPDATE_LIST2 ||
  mDownloadStatus == UpdateDownloadStatus::UPDATE_RESOURCES2)
  {
  const std::string str = urlJoin(mUpdateServerPath, mCurrentFile);
  mDownload->addMirror(updateServer3 + str);
  mDownload->addMirror(updateServer4 + str);
  mDownload->addMirror(updateServer5 + str);
  }
  else
  {
  const STD_VECTOR<std::string> &mirrors = settings.updateMirrors;
  FOR_EACH (STD_VECTOR<std::string>::const_iterator, it, mirrors)
  {
  mDownload->addMirror(pathJoin(*it,
  mCurrentFile));
  }
  }
  }
  
  if (mStoreInMemory)
  {
  mDownload->setWriteFunction(&UpdaterWindow::memoryWrite);
  }
  else
  {
  if (mDownloadStatus == UpdateDownloadStatus::UPDATE_RESOURCES)
  {
  mDownload->setFile(pathJoin(mUpdatesDir, mCurrentFile),
  mCurrentChecksum);
  }
  else
  {
  mDownload->setFile(pathJoin(mUpdatesDir,
  mCurrentFile),
  -1);
  }
  }
  
  if (mDownloadStatus != UpdateDownloadStatus::UPDATE_RESOURCES)
  mDownload->noCache();
  
  setLabel(mCurrentFile + " (0%)");
  mDownloadComplete = false;
  
  mDownload->start();
 }

References Net::Download::addMirror(), branding, Net::Download::cancel, FOR_EACH, Configuration::getStringValue(), mCurrentChecksum, mCurrentFile, mDownload, mDownloadComplete, mDownloadStatus, memoryWrite(), mStoreInMemory, mUpdateHost, mUpdatesDir, mUpdateServerPath, mValidateXml, Net::Download::noCache(), pathJoin(), Net::Download::setFile(), setLabel(), settings, Net::Download::setWriteFunction(), Net::Download::start(), Catch::toString(), UpdateDownloadStatus::UPDATE_LIST2, UpdateDownloadStatus::UPDATE_PATCH, UpdateDownloadStatus::UPDATE_RESOURCES, UpdateDownloadStatus::UPDATE_RESOURCES2, Settings::updateMirrors, updateProgress(), updateServer3(), updateServer4(), updateServer5(), Actions::url(), and urlJoin().

Referenced by logic(), and postInit().

◆ enable()

void UpdaterWindow::enable ( )

Enables play button

Definition at line 296 of file updaterwindow.cpp.

 {
  mCancelButton->setEnabled(false);
  mPlayButton->setEnabled(true);
  mPlayButton->requestFocus();
  
  if (client->getState() != State::GAME)
  {
  if ((mUpdateType & UpdateType::Close) != 0)
  client->setState(State::LOAD_DATA);
  }
  else
  {
  deleteSelf();
  }
 }

References client, UpdateType::Close, deleteSelf(), State::GAME, Client::getState(), State::LOAD_DATA, mCancelButton, mPlayButton, mUpdateType, Widget::requestFocus(), Widget::setEnabled(), and Client::setState().

Referenced by logic().

◆ getFileHash()

unsigned long UpdaterWindow::getFileHash ( const std::string & filePath )

static

Definition at line 1085 of file updaterwindow.cpp.

 {
  int size = 0;
  const char *const buf = VirtFs::loadFile(filePath, size);
  if (buf == nullptr)
  return 0;
  unsigned long res = Net::Download::adlerBuffer(buf, size);
  delete [] buf;
  return res;
 }

References Net::Download::adlerBuffer(), VirtFs::loadFile(), and EmoteDB::size().

Referenced by LocalPlayer::setTestParticle(), and LocalPlayer::slowLogic().

◆ keyPressed()

void UpdaterWindow::keyPressed ( KeyEvent & event )

virtual

Called if a key is pressed when the widget has keyboard focus. If a key is held down the widget will generate multiple key presses.

Parameters

event Discribes the event.

Reimplemented from KeyListener.

Definition at line 337 of file updaterwindow.cpp.

 {
  const InputActionT actionId = event.getActionId();
  if (actionId == InputAction::GUI_CANCEL)
  {
  action(ActionEvent(nullptr, mCancelButton->getActionEventId()));
  if (client->getState() != State::GAME)
  client->setState(State::LOGIN);
  else
  deleteSelf();
  }
  else if (actionId == InputAction::GUI_SELECT ||
  actionId == InputAction::GUI_SELECT2)
  {
  if (mDownloadStatus == UpdateDownloadStatus::UPDATE_COMPLETE ||
  mDownloadStatus == UpdateDownloadStatus::UPDATE_ERROR ||
  mDownloadStatus == UpdateDownloadStatus::UPDATE_IDLE)
  {
  action(ActionEvent(nullptr, mPlayButton->getActionEventId()));
  }
  else
  {
  action(ActionEvent(nullptr, mCancelButton->getActionEventId()));
  }
  }
 }

References action(), client, deleteSelf(), State::GAME, Widget::getActionEventId(), Client::getState(), InputAction::GUI_CANCEL, InputAction::GUI_SELECT, InputAction::GUI_SELECT2, State::LOGIN, mCancelButton, mDownloadStatus, mPlayButton, Client::setState(), UpdateDownloadStatus::UPDATE_COMPLETE, UpdateDownloadStatus::UPDATE_ERROR, and UpdateDownloadStatus::UPDATE_IDLE.

◆ loadDirMods()

void UpdaterWindow::loadDirMods ( const std::string & dir )

static

Definition at line 1171 of file updaterwindow.cpp.

 {
  ModDB::load();
  const ModInfos &mods = ModDB::getAll();
  
  std::string modsString = serverConfig.getValue("mods", "");
  StringVect modsList;
  splitToStringVector(modsList, modsString, '|');
  FOR_EACH (StringVectCIter, it, modsList)
  {
  const std::string &name = *it;
  const ModInfoCIterator modIt = mods.find(name);
  if (modIt == mods.end())
  continue;
  const ModInfo *const mod = (*modIt).second;
  if (mod != nullptr)
  {
  const std::string &localDir = mod->getLocalDir();
  if (!localDir.empty())
  {
  VirtFs::mountDir(pathJoin(dir, localDir),
  Append_false);
  }
  }
  }
 }

References Append_false, FOR_EACH, ModDB::getAll(), ModInfo::getLocalDir(), ConfigurationObject::getValue(), ModDB::load(), VirtFs::mountDir(), pathJoin(), serverConfig, and splitToStringVector().

Referenced by loadMods().

◆ loadFile()

void UpdaterWindow::loadFile ( std::string file )

Definition at line 1096 of file updaterwindow.cpp.

 {
  mBrowserBox->clearRows();
  trim(file);
  
  StringVect lines;
  Files::loadTextFileLocal(mUpdatesDir + "/local/help/news.txt", lines);
  
  for (size_t i = 0, sz = lines.size(); i < sz; ++i)
  mBrowserBox->addRow(lines[i], false);
  mBrowserBox->updateHeight();
 }

References StaticBrowserBox::addRow(), StaticBrowserBox::clearRows(), Files::loadTextFileLocal(), mBrowserBox, mUpdatesDir, Catch::trim(), and StaticBrowserBox::updateHeight().

◆ loadLocalUpdates()

void UpdaterWindow::loadLocalUpdates ( const std::string & dir )

static

Definition at line 688 of file updaterwindow.cpp.

 {
  STD_VECTOR<UpdateFile> updateFiles = loadXMLFile(
  pathJoin(dir, xmlUpdateFile),
  false);
  
  if (updateFiles.empty())
  {
  logger->log("Warning this server does not have a"
  " %s file falling back to %s", xmlUpdateFile.c_str(),
  txtUpdateFile.c_str());
  updateFiles = loadTxtFile(pathJoin(dir,
  txtUpdateFile));
  }
  
  const std::string fixPath = dir + "/fix";
  for (unsigned int updateIndex = 0,
  fsz = CAST_U32(updateFiles.size());
  updateIndex < fsz;
  updateIndex++)
  {
  const UpdateFile &file = updateFiles[updateIndex];
  if (!file.group.empty())
  continue;
  UpdaterWindow::addUpdateFile(dir,
  fixPath,
  file.name,
  Append_false);
  }
  loadManaPlusUpdates(dir);
  loadMods(dir, updateFiles);
 }

References addUpdateFile(), Append_false, CAST_U32, UpdateFile::group, loadManaPlusUpdates(), loadMods(), loadTxtFile(), loadXMLFile(), Logger::log(), logger, UpdateFile::name, pathJoin(), txtUpdateFile(), and xmlUpdateFile().

◆ loadManaPlusUpdates()

void UpdaterWindow::loadManaPlusUpdates ( const std::string & dir )

static

Definition at line 746 of file updaterwindow.cpp.

 {
  std::string fixPath = dir + "/fix";
  STD_VECTOR<UpdateFile> updateFiles = loadXMLFile(
  pathJoin(fixPath, xmlUpdateFile),
  false);
  
  for (unsigned int updateIndex = 0,
  fsz = CAST_U32(updateFiles.size());
  updateIndex < fsz;
  updateIndex++)
  {
  const UpdateFile &file = updateFiles[updateIndex];
  if (!file.group.empty())
  continue;
  const std::string name = file.name;
  if (strStartWith(name, "manaplus_"))
  {
  struct stat statbuf;
  std::string fileName = pathJoin(fixPath,
  name);
  if (stat(fileName.c_str(), &statbuf) == 0)
  {
  VirtFs::mountZip(fileName,
  Append_false);
  }
  }
  }
 }

References Append_false, CAST_U32, fileName, UpdateFile::group, loadXMLFile(), VirtFs::mountZip(), UpdateFile::name, pathJoin(), strStartWith(), and xmlUpdateFile().

Referenced by loadLocalUpdates(), and loadUpdates().

◆ loadMods()

void UpdaterWindow::loadMods	(	const std::string &	dir,
		const std::vector< UpdateFile > &	updateFiles
	)

static

Definition at line 1109 of file updaterwindow.cpp.

 {
  ModDB::load();
  std::string modsString = serverConfig.getValue("mods", "");
  std::set<std::string> modsList;
  splitToStringSet(modsList, modsString, '|');
  
  const std::string fixPath = dir + "/fix";
  for (unsigned int updateIndex = 0,
  fsz = CAST_U32(updateFiles.size());
  updateIndex < fsz;
  updateIndex ++)
  {
  const UpdateFile &file = updateFiles[updateIndex];
  if (file.group.empty())
  continue;
  const std::set<std::string>::const_iterator
  it = modsList.find(file.group);
  if (it != modsList.end())
  {
  UpdaterWindow::addUpdateFile(dir,
  fixPath,
  file.name,
  Append_false);
  }
  }
  
  STD_VECTOR<UpdateFile> updateFiles2 = loadXMLFile(
  pathJoin(fixPath, xmlUpdateFile),
  true);
  
  for (unsigned int updateIndex = 0,
  fsz = CAST_U32(updateFiles2.size());
  updateIndex < fsz;
  updateIndex++)
  {
  const UpdateFile &file = updateFiles2[updateIndex];
  if (file.group.empty())
  continue;
  std::string name = file.name;
  if (strStartWith(name, "manaplus_"))
  {
  const std::set<std::string>::const_iterator
  it = modsList.find(file.group);
  if (it != modsList.end())
  {
  struct stat statbuf;
  std::string fileName = pathJoin(fixPath,
  name);
  if (stat(fileName.c_str(), &statbuf) == 0)
  {
  VirtFs::mountZip(fileName,
  Append_false);
  }
  }
  }
  }
  
  loadDirMods(dir + "/local/");
 }

References addUpdateFile(), Append_false, CAST_U32, fileName, ConfigurationObject::getValue(), UpdateFile::group, ModDB::load(), loadDirMods(), loadXMLFile(), VirtFs::mountZip(), UpdateFile::name, pathJoin(), serverConfig, splitToStringSet(), strStartWith(), and xmlUpdateFile().

Referenced by loadLocalUpdates(), and loadUpdates().

◆ loadNews()

void UpdaterWindow::loadNews ( )

Loads and display news. Assumes the news file contents have been loaded into the memory buffer.

Definition at line 364 of file updaterwindow.cpp.

 {
  if (mMemoryBuffer == nullptr)
  {
  logger->log1("Couldn't load news");
  return;
  }
  
  // Reallocate and include terminating 0 character
  mMemoryBuffer = static_cast<char*>(realloc(
  mMemoryBuffer, mDownloadedBytes + 1));
  if (mMemoryBuffer == nullptr)
  {
  logger->log1("Couldn't load news");
  return;
  }
  mMemoryBuffer[mDownloadedBytes] = '\0';
  mBrowserBox->clearRows();
  
  std::string newsName = mUpdatesDir + "/local/help/news.txt";
  mkdir_r((mUpdatesDir + "/local/help/").c_str());
  bool firstLine(true);
  std::ofstream file;
  std::stringstream ss(mMemoryBuffer);
  std::string line;
  file.open(newsName.c_str(), std::ios::out);
  int cnt = 0;
  const int maxNews = 50;
  while (std::getline(ss, line, '\n'))
  {
  cnt ++;
  if (firstLine)
  {
  firstLine = false;
  const size_t i = line.find("##9 Latest client version: ##6");
  if (i == 0U)
  continue;
  
  if (file.is_open())
  file << line << std::endl;
  if (cnt < maxNews)
  mBrowserBox->addRow(line, false);
  }
  else
  {
  if (file.is_open())
  file << line << std::endl;
  if (cnt < maxNews)
  mBrowserBox->addRow(line, false);
  }
  }
  
  file.close();
  if (cnt > maxNews)
  {
  mBrowserBox->addRow("", false);
  // TRANSLATORS: updater window checkbox
  mBrowserBox->addRow("news", _("Show all news (can be slow)"));
  mBrowserBox->addRow("", false);
  }
  // Free the memory buffer now that we don't need it anymore
  free(mMemoryBuffer);
  mMemoryBuffer = nullptr;
  mDownloadedBytes = 0;
  
  mBrowserBox->updateHeight();
  mScrollArea->setVerticalScrollAmount(0);
 }

References _, StaticBrowserBox::addRow(), StaticBrowserBox::clearRows(), Logger::log1(), logger, mBrowserBox, mDownloadedBytes, mkdir_r(), mMemoryBuffer, mScrollArea, mUpdatesDir, ScrollArea::setVerticalScrollAmount(), and StaticBrowserBox::updateHeight().

Referenced by logic().

◆ loadPatch()

void UpdaterWindow::loadPatch ( )

Definition at line 433 of file updaterwindow.cpp.

 {
  if (mMemoryBuffer == nullptr)
  {
  logger->log1("Couldn't load patch");
  return;
  }
  
  // Reallocate and include terminating 0 character
  mMemoryBuffer = static_cast<char*>(
  realloc(mMemoryBuffer, mDownloadedBytes + 1));
  if (mMemoryBuffer == nullptr)
  {
  logger->log1("Couldn't load patch");
  return;
  }
  mMemoryBuffer[mDownloadedBytes] = '\0';
  
  std::string version;
  
  // Tokenize and add each line separately
  char *line = strtok(mMemoryBuffer, "\n");
  if (line != nullptr)
  {
  version = line;
  if (serverVersion == 0)
  {
  line = strtok(nullptr, "\n");
  if (line != nullptr)
  {
  mBrowserBox->addRow(strprintf("##9 Latest client version: "
  "##6ManaPlus %s##0", line), true);
  }
  }
  if (version > CHECK_VERSION)
  {
  mBrowserBox->addRow("", true);
 #if defined(ANDROID)
  const std::string url = "androidDownloadUrl";
  const std::string text = "androidDownloadUrl";
 #elif defined(WIN32)
  const std::string url = "windowsDownloadUrl";
  const std::string text = "windowsDownloadUrl";
 #else // defined(ANDROID)
  
  const std::string url = "otherDownloadUrl";
  const std::string text = "otherDownloadUrl";
 #endif // defined(ANDROID)
  
  mBrowserBox->addRow(std::string(" ##1[@@").append(
  branding.getStringValue(url)).append("|").append(
  branding.getStringValue(text)).append("@@]"), true);
  mBrowserBox->addRow("##1You can download it from", true);
  mBrowserBox->addRow("##1ManaPlus updated.", true);
  }
  else
  {
  mBrowserBox->addRow("You have latest client version.", true);
  }
  }
  
  // Free the memory buffer now that we don't need it anymore
  free(mMemoryBuffer);
  mMemoryBuffer = nullptr;
  mDownloadedBytes = 0;
  
  mBrowserBox->updateHeight();
  mScrollArea->setVerticalScrollAmount(0);
 }

References StaticBrowserBox::addRow(), branding, CHECK_VERSION, Configuration::getStringValue(), Logger::log1(), logger, mBrowserBox, mDownloadedBytes, mMemoryBuffer, mScrollArea, serverVersion, ScrollArea::setVerticalScrollAmount(), strprintf(), StaticBrowserBox::updateHeight(), and Actions::url().

Referenced by logic().

◆ loadUpdates()

void UpdaterWindow::loadUpdates ( )

private

Loads the updates this window has gotten into the resource manager

Definition at line 656 of file updaterwindow.cpp.

 {
  if (mUpdateFiles.empty())
  { // updates not downloaded
  mUpdateFiles = loadXMLFile(pathJoin(mUpdatesDir, xmlUpdateFile),
  false);
  if (mUpdateFiles.empty())
  {
  logger->log("Warning this server does not have a"
  " %s file falling back to %s", xmlUpdateFile.c_str(),
  txtUpdateFile.c_str());
  mUpdateFiles = loadTxtFile(pathJoin(mUpdatesDir,
  txtUpdateFile));
  }
  }
  
  std::string fixPath = mUpdatesDir + "/fix";
  const unsigned sz = CAST_U32(mUpdateFiles.size());
  for (mUpdateIndex = 0; mUpdateIndex < sz; mUpdateIndex++)
  {
  const UpdateFile &file = mUpdateFiles[mUpdateIndex];
  if (!file.group.empty())
  continue;
  UpdaterWindow::addUpdateFile(mUpdatesDir,
  fixPath,
  file.name,
  Append_false);
  }
  loadManaPlusUpdates(mUpdatesDir);
  loadMods(mUpdatesDir, mUpdateFiles);
 }

References addUpdateFile(), Append_false, CAST_U32, UpdateFile::group, loadManaPlusUpdates(), loadMods(), loadTxtFile(), loadXMLFile(), Logger::log(), logger, mUpdateFiles, mUpdateIndex, mUpdatesDir, UpdateFile::name, pathJoin(), txtUpdateFile(), and xmlUpdateFile().

Referenced by ~UpdaterWindow().

◆ logic()

void UpdaterWindow::logic ( )

virtual

Called for all widgets in the gui each time Gui::logic is called. You can do logic stuff here like playing an animation.

See also: Gui::logic

Reimplemented from BasicContainer.

Definition at line 829 of file updaterwindow.cpp.

 {
  BLOCK_START("UpdaterWindow::logic")
  // Update Scroll logic
  mScrollArea->logic();
  
  // Synchronize label caption when necessary
  {
  MutexLocker lock(&mDownloadMutex);
  
  if (mLabel->getCaption() != mNewLabelCaption)
  {
  mLabel->setCaption(mNewLabelCaption);
  mLabel->adjustSize();
  }
  
  mProgressBar->setProgress(mDownloadProgress);
  if (!mUpdateFiles.empty() &&
  CAST_SIZE(mUpdateIndex) <= mUpdateFiles.size())
  {
  mProgressBar->setText(strprintf("%u/%u", mUpdateIndex
  + mUpdateIndexOffset + 1, CAST_U32(
  mUpdateFiles.size()) + CAST_S32(
  mTempUpdateFiles.size()) + 1));
  }
  else
  {
  mProgressBar->setText("");
  }
  }
  
  switch (mDownloadStatus)
  {
  case UpdateDownloadStatus::UPDATE_ERROR:
  mBrowserBox->addRow("", false);
  // TRANSLATORS: update message
  mBrowserBox->addRow(_("##1 The update process is incomplete."),
  false);
  // TRANSLATORS: Continues "The update process is incomplete.".
  mBrowserBox->addRow(_("##1 It is strongly recommended that"),
  false);
  // TRANSLATORS: Begins "It is strongly recommended that".
  mBrowserBox->addRow(_("##1 you try again later."),
  false);
  if (mDownload != nullptr)
  mBrowserBox->addRow(mDownload->getError(), false);
  mBrowserBox->updateHeight();
  mScrollArea->setVerticalScrollAmount(
  mScrollArea->getVerticalMaxScroll());
  mDownloadStatus = UpdateDownloadStatus::UPDATE_COMPLETE;
  break;
  case UpdateDownloadStatus::UPDATE_NEWS:
  if (mDownloadComplete)
  {
  // Parse current memory buffer as news and dispose of the data
  loadNews();
  
  mValidateXml = true;
  mCurrentFile = xmlUpdateFile;
  mStoreInMemory = false;
  mDownloadStatus = UpdateDownloadStatus::UPDATE_LIST;
  download(); // download() changes mDownloadComplete to false
  }
  break;
  case UpdateDownloadStatus::UPDATE_PATCH:
  if (mDownloadComplete)
  {
  // Parse current memory buffer as news and dispose of the data
  loadPatch();
  
  mUpdateHost = updateServer2 + mUpdateServerPath;
  mUpdatesDir = pathJoin(mUpdatesDir, "fix");
  mCurrentFile = xmlUpdateFile;
  mValidateXml = true;
  mStoreInMemory = false;
  mDownloadStatus = UpdateDownloadStatus::UPDATE_LIST2;
  download();
  }
  break;
  
  case UpdateDownloadStatus::UPDATE_LIST:
  if (mDownloadComplete)
  {
  if (mCurrentFile == xmlUpdateFile)
  {
  mUpdateFiles = loadXMLFile(pathJoin(
  mUpdatesDir, xmlUpdateFile),
  true);
  
  if (mUpdateFiles.empty())
  {
  logger->log("Warning this server does not have a %s"
  " file falling back to %s",
  xmlUpdateFile.c_str(),
  txtUpdateFile.c_str());
  
  // If the resources.xml file fails,
  // fall back onto a older version
  mCurrentFile = txtUpdateFile;
  mValidateXml = false;
  mStoreInMemory = false;
  mDownloadStatus = UpdateDownloadStatus::UPDATE_LIST;
  download();
  break;
  }
  }
  else if (mCurrentFile == txtUpdateFile)
  {
  mValidateXml = true;
  mUpdateFiles = loadTxtFile(pathJoin(mUpdatesDir,
  txtUpdateFile));
  }
  mStoreInMemory = false;
  mDownloadStatus = UpdateDownloadStatus::UPDATE_RESOURCES;
  }
  break;
  case UpdateDownloadStatus::UPDATE_RESOURCES:
  if (mDownloadComplete)
  {
  if (CAST_SIZE(mUpdateIndex) < mUpdateFiles.size())
  {
  UpdateFile thisFile = mUpdateFiles[mUpdateIndex];
  if (thisFile.type == "music"
  && !config.getBoolValue("download-music"))
  {
  mUpdateIndex++;
  break;
  }
  mCurrentFile = thisFile.name;
  std::string checksum;
  checksum = thisFile.hash;
  std::stringstream ss(checksum);
  ss >> std::hex >> mCurrentChecksum;
  
  std::ifstream temp(pathJoin(mUpdatesDir,
  mCurrentFile).c_str());
  
  mValidateXml = false;
  if (!temp.is_open() || !validateFile(pathJoin(
  mUpdatesDir, mCurrentFile),
  mCurrentChecksum))
  {
  temp.close();
  download();
  }
  else
  {
  temp.close();
  logger->log("%s already here", mCurrentFile.c_str());
  }
  mUpdateIndex++;
  }
  else
  {
  if (!mSkipPatches)
  {
  // Download of updates completed
  mCurrentFile = "latest.txt";
  mStoreInMemory = true;
  mDownloadStatus = UpdateDownloadStatus::UPDATE_PATCH;
  mValidateXml = false;
  download(); // download() changes
  // mDownloadComplete to false
  }
  else
  {
  mDownloadStatus =
  UpdateDownloadStatus::UPDATE_COMPLETE;
  }
  }
  }
  break;
  case UpdateDownloadStatus::UPDATE_LIST2:
  if (mDownloadComplete)
  {
  if (mCurrentFile == xmlUpdateFile)
  {
  mTempUpdateFiles = loadXMLFile(pathJoin(
  mUpdatesDir, xmlUpdateFile),
  true);
  }
  mUpdateIndexOffset = mUpdateIndex;
  mUpdateIndex = 0;
  mValidateXml = true;
  mStoreInMemory = false;
  mDownloadStatus = UpdateDownloadStatus::UPDATE_RESOURCES2;
  download();
  }
  break;
  case UpdateDownloadStatus::UPDATE_RESOURCES2:
  if (mDownloadComplete)
  {
  mValidateXml = false;
  if (CAST_SIZE(mUpdateIndex)
  < mTempUpdateFiles.size())
  {
  const UpdateFile thisFile = mTempUpdateFiles[mUpdateIndex];
  mCurrentFile = thisFile.name;
  std::string checksum;
  checksum = thisFile.hash;
  std::stringstream ss(checksum);
  ss >> std::hex >> mCurrentChecksum;
  
  std::ifstream temp((pathJoin(mUpdatesDir,
  mCurrentFile)).c_str());
  
  if (!temp.is_open() || !validateFile(pathJoin(
  mUpdatesDir, mCurrentFile),
  mCurrentChecksum))
  {
  temp.close();
  download();
  }
  else
  {
  temp.close();
  logger->log("%s already here", mCurrentFile.c_str());
  }
  mUpdateIndex++;
  }
  else
  {
  mUpdatesDir = mUpdatesDirReal;
  mDownloadStatus = UpdateDownloadStatus::UPDATE_COMPLETE;
  }
  }
  break;
  case UpdateDownloadStatus::UPDATE_COMPLETE:
  mUpdatesDir = mUpdatesDirReal;
  enable();
  // TRANSLATORS: updater window label
  setLabel(_("Completed"));
  mDownloadStatus = UpdateDownloadStatus::UPDATE_IDLE;
  break;
  case UpdateDownloadStatus::UPDATE_IDLE:
  break;
  default:
  logger->log("UpdaterWindow::logic unknown status: "
  + toString(CAST_U32(mDownloadStatus)));
  break;
  }
  BLOCK_END("UpdaterWindow::logic")
 }

◆ memoryWrite()

size_t UpdaterWindow::memoryWrite	(	void *	ptr,
		size_t	size,
		size_t	nmemb,
		void *	stream
	)

staticprivate

A libcurl callback for writing to memory.

Definition at line 563 of file updaterwindow.cpp.

 {
  UpdaterWindow *const uw = reinterpret_cast<UpdaterWindow *>(stream);
  const size_t totalMem = size * nmemb;
  if (uw == nullptr)
  return 0;
  uw->mMemoryBuffer = static_cast<char*>(realloc(uw->mMemoryBuffer,
  CAST_SIZE(uw->mDownloadedBytes) + totalMem));
  if (uw->mMemoryBuffer != nullptr)
  {
  memcpy(&(uw->mMemoryBuffer[uw->mDownloadedBytes]), ptr, totalMem);
  uw->mDownloadedBytes += CAST_S32(totalMem);
  }
  
  return totalMem;
 }

References CAST_S32, CAST_SIZE, mDownloadedBytes, mMemoryBuffer, and EmoteDB::size().

Referenced by download().

◆ postInit()

void UpdaterWindow::postInit ( )

virtual

Reimplemented from Window.

Definition at line 257 of file updaterwindow.cpp.

 {
  Window::postInit();
  setVisible(Visible_true);
  mCancelButton->requestFocus();
  removeProtocol(mUpdateServerPath);
  
  download();
 }

References download(), mCancelButton, mUpdateServerPath, Window::postInit(), removeProtocol(), Widget::requestFocus(), Window::setVisible(), and Visible_true.

◆ removeUpdateFile()

void UpdaterWindow::removeUpdateFile	(	const std::string &	path,
		const std::string &	fixPath,
		const std::string &	filerestrict
	)

static

Definition at line 818 of file updaterwindow.cpp.

 {
  VirtFs::unmountZip(pathJoin(path, file));
  const std::string fixFile = pathJoin(fixPath, file);
  struct stat statbuf;
  if (stat(fixFile.c_str(), &statbuf) == 0)
  VirtFs::unmountZip(fixFile);
 }

References pathJoin(), and VirtFs::unmountZip().

Referenced by unloadUpdates().

◆ setLabel()

void UpdaterWindow::setLabel ( const std::string & str )

Set's label above progress

Definition at line 289 of file updaterwindow.cpp.

 {
  // Do delayed label text update, since Guichan isn't thread-safe
  MutexLocker lock(&mDownloadMutex);
  mNewLabelCaption = str;
 }

References mDownloadMutex, and mNewLabelCaption.

Referenced by download(), logic(), and updateProgress().

◆ setProgress()

void UpdaterWindow::setProgress ( const float p )

Set's progress bar status

Definition at line 282 of file updaterwindow.cpp.

 {
  // Do delayed progress bar update, since Guichan isn't thread-safe
  MutexLocker lock(&mDownloadMutex);
  mDownloadProgress = p;
 }

References mDownloadMutex, and mDownloadProgress.

Referenced by updateProgress().

◆ unloadManaPlusUpdates()

void UpdaterWindow::unloadManaPlusUpdates ( const std::string & dir )

static

Definition at line 776 of file updaterwindow.cpp.

 {
  const std::string fixPath = dir + "/fix";
  const STD_VECTOR<UpdateFile> updateFiles = loadXMLFile(
  pathJoin(fixPath, xmlUpdateFile),
  true);
  
  for (unsigned int updateIndex = 0,
  fsz = CAST_U32(updateFiles.size());
  updateIndex < fsz;
  updateIndex++)
  {
  std::string name = updateFiles[updateIndex].name;
  if (strStartWith(name, "manaplus_"))
  {
  struct stat statbuf;
  const std::string file = pathJoin(
  fixPath, name);
  if (stat(file.c_str(), &statbuf) == 0)
  VirtFs::unmountZip(file);
  }
  }
 }

References CAST_U32, loadXMLFile(), pathJoin(), strStartWith(), VirtFs::unmountZip(), and xmlUpdateFile().

Referenced by unloadUpdates().

◆ unloadMods()

void UpdaterWindow::unloadMods ( const std::string & dir )

static

Definition at line 1198 of file updaterwindow.cpp.

 {
  const ModInfos &mods = ModDB::getAll();
  std::string modsString = serverConfig.getValue("mods", "");
  StringVect modsList;
  splitToStringVector(modsList, modsString, '|');
  FOR_EACH (StringVectCIter, it, modsList)
  {
  const std::string &name = *it;
  const ModInfoCIterator modIt = mods.find(name);
  if (modIt == mods.end())
  continue;
  const ModInfo *const mod = (*modIt).second;
  if (mod != nullptr)
  {
  const std::string &localDir = mod->getLocalDir();
  if (!localDir.empty())
  VirtFs::unmountDir(pathJoin(dir, localDir));
  }
  }
 }

References FOR_EACH, ModDB::getAll(), ModInfo::getLocalDir(), ConfigurationObject::getValue(), pathJoin(), serverConfig, splitToStringVector(), and VirtFs::unmountDir().

◆ unloadUpdates()

void UpdaterWindow::unloadUpdates ( const std::string & dir )

static

Definition at line 721 of file updaterwindow.cpp.

 {
  STD_VECTOR<UpdateFile> updateFiles = loadXMLFile(
  pathJoin(dir, xmlUpdateFile),
  true);
  
  if (updateFiles.empty())
  {
  updateFiles = loadTxtFile(pathJoin(dir,
  txtUpdateFile));
  }
  
  const std::string fixPath = dir + "/fix";
  for (unsigned int updateIndex = 0,
  fsz = CAST_U32(updateFiles.size());
  updateIndex < fsz;
  updateIndex++)
  {
  UpdaterWindow::removeUpdateFile(dir,
  fixPath,
  updateFiles[updateIndex].name);
  }
  unloadManaPlusUpdates(dir);
 }

References CAST_U32, loadTxtFile(), loadXMLFile(), pathJoin(), removeUpdateFile(), txtUpdateFile(), unloadManaPlusUpdates(), and xmlUpdateFile().

Referenced by Client::unloadData().

◆ updateProgress()

int UpdaterWindow::updateProgress	(	void *	ptr,
		const DownloadStatusT	status,
		size_t	dt,
		const size_t	dn
	)

staticprivate

A download callback for progress updates.

Definition at line 503 of file updaterwindow.cpp.

 {
  UpdaterWindow *const uw = reinterpret_cast<UpdaterWindow *>(ptr);
  if (uw == nullptr)
  return -1;
  
  if (status == DownloadStatus::Complete)
  {
  uw->mDownloadComplete = true;
  }
  else if (status == DownloadStatus::Error ||
  status == DownloadStatus::Cancelled)
  {
  if (uw->mDownloadStatus == UpdateDownloadStatus::UPDATE_COMPLETE ||
  uw->mDownloadStatus == UpdateDownloadStatus::UPDATE_NEWS)
  { // ignoring error in last state (was UPDATE_PATCH)
  uw->mDownloadStatus = UpdateDownloadStatus::UPDATE_COMPLETE;
  uw->mDownloadComplete = true;
  free(uw->mMemoryBuffer);
  uw->mMemoryBuffer = nullptr;
  }
  else
  {
  uw->mDownloadStatus = UpdateDownloadStatus::UPDATE_ERROR;
  }
  }
  
  if (dt == 0U)
  dt = 1;
  
  float progress = static_cast<float>(dn) /
  static_cast<float>(dt);
  
  if (progress != progress)
  progress = 0.0F; // check for NaN
  if (progress < 0.0F)
  progress = 0.0F; // no idea how this could ever happen,
  // but why not check for it anyway.
  if (progress > 1.0F)
  progress = 1.0F;
  
  uw->setLabel(std::string(uw->mCurrentFile).append(" (")
  .append(toString(CAST_S32(progress * 100))).append("%)"));
  
  uw->setProgress(progress);
  
  if ((client->getState() != State::UPDATE &&
  client->getState() != State::GAME) ||
  uw->mDownloadStatus == UpdateDownloadStatus::UPDATE_ERROR)
  {
  // If the action was canceled return an error code to stop the mThread
  return -1;
  }
  
  return 0;
 }

References DownloadStatus::Cancelled, CAST_S32, client, DownloadStatus::Complete, DownloadStatus::Error, State::GAME, Client::getState(), mCurrentFile, mDownloadComplete, mDownloadStatus, mMemoryBuffer, setLabel(), setProgress(), Catch::toString(), State::UPDATE, UpdateDownloadStatus::UPDATE_COMPLETE, UpdateDownloadStatus::UPDATE_ERROR, and UpdateDownloadStatus::UPDATE_NEWS.

Referenced by download().

◆ validateFile()

bool UpdaterWindow::validateFile	(	const std::string &	filePath,
		const unsigned long	hash
	)

staticprivate

Definition at line 1073 of file updaterwindow.cpp.

 {
  FILE *const file = fopen(filePath.c_str(), "rb");
  if (file == nullptr)
  return false;
  
  const unsigned long adler = Net::Download::fadler32(file);
  fclose(file);
  return adler == hash;
 }

References Net::Download::fadler32().

Referenced by logic().

Field Documentation

◆ mBrowserBox

StaticBrowserBox* UpdaterWindow::mBrowserBox

private

Definition at line 215 of file updaterwindow.h.

Referenced by loadFile(), loadNews(), loadPatch(), logic(), and UpdaterWindow().

◆ mCancelButton

Button* UpdaterWindow::mCancelButton

private

Definition at line 212 of file updaterwindow.h.

Referenced by enable(), keyPressed(), postInit(), and UpdaterWindow().

◆ mCurrentChecksum

unsigned long UpdaterWindow::mCurrentChecksum

private

The Adler32 checksum of the file currently downloading.

Definition at line 194 of file updaterwindow.h.

Referenced by download(), and logic().

◆ mCurrentFile

std::string UpdaterWindow::mCurrentFile

private

The file currently downloading.

Definition at line 184 of file updaterwindow.h.

Referenced by download(), logic(), and updateProgress().

◆ mDownload

Net::Download* UpdaterWindow::mDownload

private

Download handle.

Definition at line 200 of file updaterwindow.h.

Referenced by action(), download(), logic(), and ~UpdaterWindow().

◆ mDownloadComplete

bool UpdaterWindow::mDownloadComplete

private

Flag that show if current download is complete.

Definition at line 238 of file updaterwindow.h.

Referenced by download(), logic(), and updateProgress().

◆ mDownloadedBytes

int UpdaterWindow::mDownloadedBytes

private

Byte count currently downloaded in mMemoryBuffer.

Definition at line 222 of file updaterwindow.h.

Referenced by loadNews(), loadPatch(), and memoryWrite().

◆ mDownloadMutex

Mutex UpdaterWindow::mDownloadMutex

private

Definition at line 191 of file updaterwindow.h.

Referenced by logic(), setLabel(), and setProgress().

◆ mDownloadProgress

float UpdaterWindow::mDownloadProgress

private

The new progress value to be set in the logic method.

Definition at line 173 of file updaterwindow.h.

Referenced by logic(), and setProgress().

◆ mDownloadStatus

UpdateDownloadStatusT UpdaterWindow::mDownloadStatus

private

Status of the current download.

Definition at line 219 of file updaterwindow.h.

Referenced by action(), download(), keyPressed(), logic(), and updateProgress().

◆ mItemLinkHandler

ItemLinkHandler* UpdaterWindow::mItemLinkHandler

private

Definition at line 210 of file updaterwindow.h.

Referenced by UpdaterWindow(), and ~UpdaterWindow().

◆ mLabel

Label* UpdaterWindow::mLabel

private

Definition at line 211 of file updaterwindow.h.

Referenced by logic(), and UpdaterWindow().

◆ mLoadUpdates

bool UpdaterWindow::mLoadUpdates

private

Tells ~UpdaterWindow() if it should load updates

Definition at line 244 of file updaterwindow.h.

Referenced by ~UpdaterWindow().

◆ mMemoryBuffer

char* UpdaterWindow::mMemoryBuffer

private

Buffer for files downloaded to memory.

Definition at line 197 of file updaterwindow.h.

Referenced by loadNews(), loadPatch(), memoryWrite(), updateProgress(), and ~UpdaterWindow().

◆ mNewLabelCaption

std::string UpdaterWindow::mNewLabelCaption

private

The new label caption to be set in the logic method.

Definition at line 187 of file updaterwindow.h.

Referenced by logic(), and setLabel().

◆ mPlayButton

Button* UpdaterWindow::mPlayButton

private

Definition at line 213 of file updaterwindow.h.

Referenced by enable(), keyPressed(), and UpdaterWindow().

◆ mProgressBar

ProgressBar* UpdaterWindow::mProgressBar

private

Definition at line 214 of file updaterwindow.h.

Referenced by logic(), and UpdaterWindow().

◆ mScrollArea

ScrollArea* UpdaterWindow::mScrollArea

private

Definition at line 216 of file updaterwindow.h.

Referenced by loadNews(), loadPatch(), logic(), and UpdaterWindow().

◆ mSkipPatches

bool UpdaterWindow::mSkipPatches

private

Definition at line 248 of file updaterwindow.h.

Referenced by logic(), and UpdaterWindow().

◆ mStoreInMemory

bool UpdaterWindow::mStoreInMemory

private

A flag to indicate whether to use a memory buffer or a regular file.

Definition at line 235 of file updaterwindow.h.

Referenced by download(), and logic().

◆ mTempUpdateFiles

std::vector<UpdateFile> UpdaterWindow::mTempUpdateFiles

private

List of temp files to download.

Definition at line 206 of file updaterwindow.h.

Referenced by logic().

◆ mUpdateFiles

std::vector<UpdateFile> UpdaterWindow::mUpdateFiles

private

List of files to download.

Definition at line 203 of file updaterwindow.h.

Referenced by loadUpdates(), and logic().

◆ mUpdateHost

std::string UpdaterWindow::mUpdateHost

private

Host where we get the updated files.

Definition at line 176 of file updaterwindow.h.

Referenced by download(), logic(), and UpdaterWindow().

◆ mUpdateIndex

unsigned int UpdaterWindow::mUpdateIndex

private

Index of the file to be downloaded.

Definition at line 225 of file updaterwindow.h.

Referenced by loadUpdates(), and logic().

◆ mUpdateIndexOffset

unsigned int UpdaterWindow::mUpdateIndexOffset

private

Index offset for disaplay downloaded file.

Definition at line 228 of file updaterwindow.h.

Referenced by logic().

◆ mUpdatesDir

std::string UpdaterWindow::mUpdatesDir

private

Place where the updates are stored (absolute path).

Definition at line 179 of file updaterwindow.h.

Referenced by download(), loadFile(), loadNews(), loadUpdates(), and logic().

◆ mUpdatesDirReal

std::string UpdaterWindow::mUpdatesDirReal

private

Definition at line 181 of file updaterwindow.h.

Referenced by logic().

◆ mUpdateServerPath

std::string UpdaterWindow::mUpdateServerPath

private

Definition at line 208 of file updaterwindow.h.

Referenced by download(), logic(), and postInit().

◆ mUpdateType

UpdateTypeT UpdaterWindow::mUpdateType

private

Definition at line 230 of file updaterwindow.h.

Referenced by enable().

◆ mUserCancel

bool UpdaterWindow::mUserCancel

private

Flag that show if the user has canceled the update.

Definition at line 241 of file updaterwindow.h.

Referenced by action().

◆ mValidateXml

bool UpdaterWindow::mValidateXml

private

Definition at line 246 of file updaterwindow.h.

Referenced by download(), and logic().

The documentation for this class was generated from the following files:

src/gui/windows/updaterwindow.h (986a3bf)
src/gui/windows/updaterwindow.cpp (986a3bf)

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UpdaterWindow()

◆ ~UpdaterWindow()

Member Function Documentation

◆ action()

◆ addUpdateFile()

◆ deleteSelf()

◆ download()

◆ enable()

◆ getFileHash()

◆ keyPressed()

◆ loadDirMods()

◆ loadFile()

◆ loadLocalUpdates()

◆ loadManaPlusUpdates()

◆ loadMods()

◆ loadNews()

◆ loadPatch()

◆ loadUpdates()

◆ logic()

◆ memoryWrite()

◆ postInit()

◆ removeUpdateFile()

◆ setLabel()

◆ setProgress()

◆ unloadManaPlusUpdates()

◆ unloadMods()

◆ unloadUpdates()

◆ updateProgress()

◆ validateFile()

Field Documentation

◆ mBrowserBox

◆ mCancelButton

◆ mCurrentChecksum

◆ mCurrentFile

◆ mDownload

◆ mDownloadComplete

◆ mDownloadedBytes

◆ mDownloadMutex

◆ mDownloadProgress

◆ mDownloadStatus

◆ mItemLinkHandler

◆ mLabel

◆ mLoadUpdates

◆ mMemoryBuffer

◆ mNewLabelCaption

◆ mPlayButton

◆ mProgressBar

◆ mScrollArea

◆ mSkipPatches

◆ mStoreInMemory

◆ mTempUpdateFiles

◆ mUpdateFiles

◆ mUpdateHost

◆ mUpdateIndex

◆ mUpdateIndexOffset

◆ mUpdatesDir

◆ mUpdatesDirReal

◆ mUpdateServerPath

◆ mUpdateType

◆ mUserCancel

◆ mValidateXml