spotlight_images.cpp

/*
** MIT License
**
** Copyright(c) 2021 Alec Musasa
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this softwareand associated documentation files(the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and /or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions :
**
** The above copyright noticeand this permission notice shall be included in all
** copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
** OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
** SOFTWARE.
*/

#include <string>
#include <filesystem>
#include <Windows.h>
#include <ShlObj.h>

#include <GdiPlus.h>
#pragma comment(lib, "GdiPlus.lib")

#include "spotlight_images.h"
#include "helper_functions.h"

/// <summary>
/// The minimum size of the smallest side in a valid Windows Spotlight image.
/// </summary>
constexpr auto SPOTLIGHT_MIN = 700;

/// <summary>
/// Algorithm for checking if a given image is a valid Windows Spotlight image.
/// </summary>
/// 
/// <param name="gdibitmap">
/// A reference to the Gdiplus bitmap.
/// </param>
/// 
/// <returns>
/// Returns true if the image is valid, else false.
/// </returns>
bool is_valid_spotlight_image(Gdiplus::Bitmap& gdibitmap) {
	// check square images
	if (gdibitmap.GetWidth() == gdibitmap.GetHeight())
		return false;

	const bool is_landscape = gdibitmap.GetWidth() > gdibitmap.GetHeight();

	// check small images that are probably not what we're looking for
	if (is_landscape && gdibitmap.GetHeight() < SPOTLIGHT_MIN)
		return false;
	else
		if (!is_landscape && gdibitmap.GetWidth() < SPOTLIGHT_MIN)
			return false;

	return true;
}

std::vector<image_info> fetch_images(const std::string& folder) {
	auto get_app_data_folder = []() {
		CHAR szPath[MAX_PATH];
		if (SUCCEEDED(SHGetFolderPathA(NULL, CSIDL_LOCAL_APPDATA, NULL, 0, szPath))) {
			/*
			** C:\Users\<username>\AppData\ (Vista onwards) or
			** C:\Documents and Settings\<username>\AppData\ (XP)
			*/
			return std::string(szPath);
		}
		else
			return std::string();
	};

	// get Windows spotlight directory for current user
	std::string path = get_app_data_folder() +
		"\\Packages\\Microsoft.Windows.ContentDeliveryManager_cw5n1h2txyewy\\LocalState\\Assets";

	// get the list of files in the spotlight folder
	std::vector<std::filesystem::path> file_list;
	for (const auto& entry : std::filesystem::directory_iterator(path))
		if (entry.is_regular_file())
			file_list.push_back(entry.path());

	std::vector<image_info> images;

	try {
		// eliminate files that don't make sense
		for (auto& it : file_list) {
			// get path
			const std::string source_path = it.string();

			// create GDI+ bitmap from file
			Gdiplus::Bitmap* p_gdibitmap =
				new Gdiplus::Bitmap(std::basic_string<TCHAR>(source_path.begin(), source_path.end()).c_str());

			// get status information
			Gdiplus::Status status = p_gdibitmap->GetLastStatus();

			// check if an error occured
			if (status != 0) {
				// delete bitmap from memory
				if (p_gdibitmap) {
					delete p_gdibitmap;
					p_gdibitmap = NULL;
				}
			}
			else {
				// skip invalid images
				if (!is_valid_spotlight_image(*p_gdibitmap))
					continue;

				const bool is_landscape = p_gdibitmap->GetWidth() > p_gdibitmap->GetHeight();

				// get file name
				std::string file_name;
				get_filename_from_full_path(it.string(), file_name);

				// create new folder
				std::string new_folder = folder;

				try {
					// if the "Windows SpotLight' folder doesn't exist, create it
					std::filesystem::create_directory(new_folder);

					if (is_landscape)
						new_folder += "\\Landscape";
					else
						new_folder += "\\Portrait";

					// if the sub-folder doesn't exist, create it
					std::filesystem::create_directory(new_folder);

					std::string new_file = new_folder + "\\" + file_name + ".jpg";

					// if the file exists, delete it
					std::filesystem::directory_entry destination_path(new_file);

					if (destination_path.exists())
						std::remove(new_file.c_str());

					// save the image to the new file with the .jpg extension
					std::filesystem::copy_file(it, new_file);

					images.push_back({
						is_landscape ? image_orientation::landscape :
						image_orientation::portrait,
						new_file,
						std::filesystem::file_size(it),
						p_gdibitmap->GetWidth(),
						p_gdibitmap->GetHeight()
						});
				}
				catch (const std::exception&) {
					// to-do: log error
				}

				// delete bitmap from memory
				if (p_gdibitmap) {
					delete p_gdibitmap;
					p_gdibitmap = NULL;
				}
			}
		}
	}
	catch (const std::exception&) {
		// to-do: log error
	}

	return images;
}