BS 0.1 基础构建完成 / 0.2 Visual 同为Unity UI控件部分
This commit is contained in:
757
Convention/[ES3]/Easy Save 3/Scripts/Web/ES3Cloud.cs
Normal file
757
Convention/[ES3]/Easy Save 3/Scripts/Web/ES3Cloud.cs
Normal file
@@ -0,0 +1,757 @@
|
||||
#if !DISABLE_WEB
|
||||
using System.Collections;
|
||||
using System.Collections.Generic;
|
||||
using System.Text;
|
||||
using UnityEngine;
|
||||
using UnityEngine.Networking;
|
||||
using System;
|
||||
using ES3Internal;
|
||||
|
||||
#if UNITY_VISUAL_SCRIPTING
|
||||
[Unity.VisualScripting.IncludeInSettings(true)]
|
||||
#elif BOLT_VISUAL_SCRIPTING
|
||||
[Ludiq.IncludeInSettings(true)]
|
||||
#endif
|
||||
public class ES3Cloud : ES3WebClass
|
||||
{
|
||||
int timeout = 20;
|
||||
|
||||
/// <summary>Constructs an new ES3Cloud object with the given URL to an ES3.php file.</summary>
|
||||
/// <param name="url">The URL of the ES3.php file on your server you want to use.</param>
|
||||
public ES3Cloud(string url, string apiKey) : base(url, apiKey)
|
||||
{
|
||||
}
|
||||
|
||||
public ES3Cloud(string url, string apiKey, int timeout) : base(url, apiKey)
|
||||
{
|
||||
this.timeout = timeout;
|
||||
}
|
||||
|
||||
#region Downloaded Data Handling
|
||||
|
||||
/// <summary>The encoding to use when encoding and decoding data as strings.</summary>
|
||||
public System.Text.Encoding encoding = System.Text.Encoding.UTF8;
|
||||
|
||||
|
||||
private byte[] _data = null;
|
||||
/// <summary>Any downloaded data, if applicable. This may also contain an error message, so you should check the 'ifError' variable before reading data.</summary>
|
||||
public byte[] data
|
||||
{
|
||||
get{ return _data; }
|
||||
}
|
||||
|
||||
/// <summary>The downloaded data as text, decoded using the encoding specified by the 'encoding' variable.</summary>
|
||||
public string text
|
||||
{
|
||||
get
|
||||
{
|
||||
if(data == null)
|
||||
return null;
|
||||
return encoding.GetString(data);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>An array of filenames downloaded from the server. This must only be accessed after calling the 'DownloadFilenames' routine.</summary>
|
||||
public string[] filenames
|
||||
{
|
||||
get
|
||||
{
|
||||
if(data == null || data.Length == 0)
|
||||
return new string[0];
|
||||
return text.Split(new char[]{';'}, StringSplitOptions.RemoveEmptyEntries);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/// <summary>A UTC DateTime object representing the date and time a file on the server was last updated. This should only be called after calling the 'DownloadTimestamp' routine.</summary>
|
||||
public DateTime timestamp
|
||||
{
|
||||
get
|
||||
{
|
||||
if(data == null || data.Length == 0)
|
||||
return new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);
|
||||
|
||||
double timestamp;
|
||||
if(!double.TryParse(text, out timestamp))
|
||||
throw new FormatException("Could not convert downloaded data to a timestamp. Data downloaded was: " + text);
|
||||
|
||||
return new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc).AddSeconds(timestamp);
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Sync
|
||||
|
||||
/// <summary>Synchronises the default file with a file on the server. If the file on the server is newer than the local copy, the local file will be overwritten by the file on the server. Otherwise, the file on the server will be overwritten.</summary>
|
||||
public IEnumerator Sync()
|
||||
{
|
||||
return Sync(new ES3Settings(), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Synchronises a local file with a file on the server. If the file on the server is newer than the local copy, the local file will be overwritten by the file on the server. Otherwise, the file on the server will be overwritten.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the local file we want to synchronise.</param>
|
||||
public IEnumerator Sync(string filePath)
|
||||
{
|
||||
return Sync(new ES3Settings(filePath), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Synchronises a local file with a file on the server. If the file on the server is newer than the local copy, the local file will be overwritten by the file on the server. Otherwise, the file on the server will be overwritten.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the local file we want to synchronise.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
public IEnumerator Sync(string filePath, string user)
|
||||
{
|
||||
return Sync(new ES3Settings(filePath), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Synchronises a local file with a file on the server. If the file on the server is newer than the local copy, the local file will be overwritten by the file on the server. Otherwise, the file on the server will be overwritten.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the local file we want to synchronise.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
public IEnumerator Sync(string filePath, string user, string password)
|
||||
{
|
||||
return Sync(new ES3Settings(filePath), user, password);
|
||||
}
|
||||
|
||||
/// <summary>Synchronises a local file with a file on the server. If the file on the server is newer than the local copy, the local file will be overwritten by the file on the server. Otherwise, the file on the server will be overwritten.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the local file we want to synchronise.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator Sync(string filePath, ES3Settings settings)
|
||||
{
|
||||
return Sync(new ES3Settings(filePath, settings), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Synchronises a local file with a file on the server. If the file on the server is newer than the local copy, the local file will be overwritten by the file on the server. Otherwise, the file on the server will be overwritten.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to use.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator Sync(string filePath, string user, ES3Settings settings)
|
||||
{
|
||||
return Sync(new ES3Settings(filePath, settings), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Synchronises a local file with a file on the server. If the file on the server is newer than the local copy, the local file will be overwritten by the file on the server. Otherwise, the file on the server will be overwritten.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the local file we want to synchronise.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator Sync(string filePath, string user, string password, ES3Settings settings)
|
||||
{
|
||||
return Sync(new ES3Settings(filePath, settings), user, password);
|
||||
}
|
||||
|
||||
/// <summary>Synchronises a local file with a file on the server. If the file on the server is newer than the local copy, the local file will be overwritten by the file on the server. Otherwise, the file on the server will be overwritten.</summary>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
private IEnumerator Sync(ES3Settings settings, string user, string password)
|
||||
{
|
||||
Reset();
|
||||
|
||||
yield return DownloadFile(settings, user, password, GetFileTimestamp(settings));
|
||||
|
||||
if(errorCode == 3)
|
||||
{
|
||||
// Clear the error.
|
||||
Reset();
|
||||
|
||||
// File does not exist on server, or is older than locally stored data, so upload the local file to the server if it exists.
|
||||
if(ES3.FileExists(settings))
|
||||
yield return UploadFile(settings, user, password);
|
||||
}
|
||||
|
||||
isDone = true;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region UploadFile
|
||||
|
||||
/// <summary>Uploads the default file to the server, overwriting any existing file.</summary>
|
||||
public IEnumerator UploadFile()
|
||||
{
|
||||
return UploadFile(new ES3Settings(), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to use.</param>
|
||||
public IEnumerator UploadFile(string filePath)
|
||||
{
|
||||
return UploadFile(new ES3Settings(filePath), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to use.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
public IEnumerator UploadFile(string filePath, string user)
|
||||
{
|
||||
return UploadFile(new ES3Settings(filePath), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to use.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
public IEnumerator UploadFile(string filePath, string user, string password)
|
||||
{
|
||||
return UploadFile(new ES3Settings(filePath), user, password);
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to use.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator UploadFile(string filePath, ES3Settings settings)
|
||||
{
|
||||
return UploadFile(new ES3Settings(filePath, settings), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to use.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator UploadFile(string filePath, string user, ES3Settings settings)
|
||||
{
|
||||
return UploadFile(new ES3Settings(filePath, settings), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to use.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator UploadFile(string filePath, string user, string password, ES3Settings settings)
|
||||
{
|
||||
return UploadFile(new ES3Settings(filePath, settings), user, password);
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="es3File">An ES3File containing the data we want to upload.</param>
|
||||
public IEnumerator UploadFile(ES3File es3File)
|
||||
{
|
||||
return UploadFile(es3File.GetBytes(), es3File.settings, "", "", DateTimeToUnixTimestamp(DateTime.Now));
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="es3File">An ES3File containing the data we want to upload.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
public IEnumerator UploadFile(ES3File es3File, string user)
|
||||
{
|
||||
return UploadFile(es3File.GetBytes(), es3File.settings, user, "", DateTimeToUnixTimestamp(DateTime.Now));
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="es3File">An ES3File containing the data we want to upload.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
public IEnumerator UploadFile(ES3File es3File, string user, string password)
|
||||
{
|
||||
return UploadFile(es3File.GetBytes(), es3File.settings, user, password, DateTimeToUnixTimestamp(DateTime.Now));
|
||||
}
|
||||
|
||||
/// <summary>Uploads a local file to the server, overwriting any existing file.</summary>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
public IEnumerator UploadFile(ES3Settings settings, string user, string password)
|
||||
{
|
||||
return UploadFile(ES3.LoadRawBytes(settings), settings, user, password);
|
||||
}
|
||||
|
||||
public IEnumerator UploadFile(byte[] bytes, ES3Settings settings, string user, string password)
|
||||
{
|
||||
return UploadFile(bytes, settings, user, password, DateTimeToUnixTimestamp(ES3.GetTimestamp(settings)));
|
||||
}
|
||||
|
||||
private IEnumerator UploadFile(byte[] bytes, ES3Settings settings, string user, string password, long fileTimestamp)
|
||||
{
|
||||
Reset();
|
||||
|
||||
var form = CreateWWWForm();
|
||||
form.AddField("apiKey", apiKey);
|
||||
form.AddField("putFile", settings.path);
|
||||
form.AddField("timestamp", fileTimestamp.ToString());
|
||||
form.AddField("user", GetUser(user, password));
|
||||
form.AddBinaryData("data", bytes, "data.dat", "multipart/form-data");
|
||||
|
||||
using(var webRequest = UnityWebRequest.Post(url, form))
|
||||
{
|
||||
webRequest.timeout = timeout;
|
||||
yield return SendWebRequest(webRequest);
|
||||
HandleError(webRequest, true);
|
||||
}
|
||||
|
||||
isDone = true;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region DownloadFile
|
||||
|
||||
/// <summary>Downloads the default file from the server and saves it locally, overwriting the existing local default file. An error is returned if the file does not exist.</summary>
|
||||
public IEnumerator DownloadFile()
|
||||
{
|
||||
return DownloadFile(new ES3Settings(), "", "", 0);
|
||||
}
|
||||
|
||||
/// <summary>Downloads a file from the server and saves it locally, overwriting any existing local file. An error is returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to download.</param>
|
||||
public IEnumerator DownloadFile(string filePath)
|
||||
{
|
||||
return DownloadFile(new ES3Settings(filePath), "", "", 0);
|
||||
}
|
||||
|
||||
/// <summary>Downloads a file from the server and saves it locally, overwriting any existing local file. An error is returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to download.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
public IEnumerator DownloadFile(string filePath, string user)
|
||||
{
|
||||
return DownloadFile(new ES3Settings(filePath), user, "", 0);
|
||||
}
|
||||
|
||||
/// <summary>Downloads a file from the server and saves it locally, overwriting any existing local file. An error is returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to download.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
public IEnumerator DownloadFile(string filePath, string user, string password)
|
||||
{
|
||||
return DownloadFile(new ES3Settings(filePath), user, password, 0);
|
||||
}
|
||||
|
||||
/// <summary>Downloads a file from the server and saves it locally, overwriting any existing local file. An error is returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to download.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator DownloadFile(string filePath, ES3Settings settings)
|
||||
{
|
||||
return DownloadFile(new ES3Settings(filePath, settings), "", "", 0);
|
||||
}
|
||||
|
||||
/// <summary>Downloads a file from the server and saves it locally, overwriting any existing local file. An error is returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to download.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator DownloadFile(string filePath, string user, ES3Settings settings)
|
||||
{
|
||||
return DownloadFile(new ES3Settings(filePath, settings), user, "", 0);
|
||||
}
|
||||
|
||||
/// <summary>Downloads a file from the server and saves it locally, overwriting any existing local file. An error is returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to download.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator DownloadFile(string filePath, string user, string password, ES3Settings settings)
|
||||
{
|
||||
return DownloadFile(new ES3Settings(filePath, settings), user, password, 0);
|
||||
}
|
||||
|
||||
/// <summary>Downloads a file from the server and saves it locally, overwriting any existing local file. An error is returned if the file does not exist.</summary>
|
||||
/// <param name="es3File">The ES3File we want to load our data into. The filename in the settings of the ES3File will be used when downloading.</param>
|
||||
public IEnumerator DownloadFile(ES3File es3File)
|
||||
{
|
||||
return DownloadFile(es3File, "", "", 0);
|
||||
}
|
||||
|
||||
/// <summary>Downloads a file from the server and saves it locally, overwriting any existing local file. An error is returned if the file does not exist.</summary>
|
||||
/// <param name="es3File">The ES3File we want to load our data into. The filename in the settings of the ES3File will be used when downloading.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
public IEnumerator DownloadFile(ES3File es3File, string user)
|
||||
{
|
||||
return DownloadFile(es3File, user, "", 0);
|
||||
}
|
||||
|
||||
/// <summary>Downloads a file from the server and saves it locally, overwriting any existing local file. An error is returned if the file does not exist.</summary>
|
||||
/// <param name="es3File">The ES3File we want to load our data into. The filename in the settings of the ES3File will be used when downloading.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
public IEnumerator DownloadFile(ES3File es3File, string user, string password)
|
||||
{
|
||||
return DownloadFile(es3File, user, password, 0);
|
||||
}
|
||||
|
||||
private IEnumerator DownloadFile(ES3File es3File, string user, string password, long timestamp)
|
||||
{
|
||||
Reset();
|
||||
|
||||
var form = CreateWWWForm();
|
||||
form.AddField("apiKey", apiKey);
|
||||
form.AddField("getFile", es3File.settings.path);
|
||||
form.AddField("user", GetUser(user, password));
|
||||
if(timestamp > 0)
|
||||
form.AddField("timestamp", timestamp.ToString());
|
||||
|
||||
using(var webRequest = UnityWebRequest.Post(url, form))
|
||||
{
|
||||
webRequest.timeout = timeout;
|
||||
|
||||
yield return SendWebRequest(webRequest);
|
||||
|
||||
if(!HandleError(webRequest, false))
|
||||
{
|
||||
if(webRequest.downloadedBytes > 0)
|
||||
{
|
||||
es3File.Clear();
|
||||
es3File.SaveRaw(webRequest.downloadHandler.data);
|
||||
}
|
||||
else
|
||||
{
|
||||
error = string.Format("File {0} was not found on the server.", es3File.settings.path);
|
||||
errorCode = 3;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
isDone = true;
|
||||
}
|
||||
|
||||
private IEnumerator DownloadFile(ES3Settings settings, string user, string password, long timestamp)
|
||||
{
|
||||
Reset();
|
||||
|
||||
var form = CreateWWWForm();
|
||||
form.AddField("apiKey", apiKey);
|
||||
form.AddField("getFile", settings.path);
|
||||
form.AddField("user", GetUser(user, password));
|
||||
if(timestamp > 0)
|
||||
form.AddField("timestamp", timestamp.ToString());
|
||||
|
||||
using(var webRequest = UnityWebRequest.Post(url, form))
|
||||
{
|
||||
webRequest.timeout = timeout;
|
||||
|
||||
yield return SendWebRequest(webRequest);
|
||||
if(!HandleError(webRequest, false))
|
||||
{
|
||||
if(webRequest.downloadedBytes > 0)
|
||||
{
|
||||
ES3.SaveRaw(webRequest.downloadHandler.data, settings);
|
||||
}
|
||||
else
|
||||
{
|
||||
error = string.Format("File {0} was not found on the server.", settings.path);
|
||||
errorCode = 3;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
isDone = true;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region DeleteFile
|
||||
|
||||
/// <summary>Deletes the default file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
public IEnumerator DeleteFile()
|
||||
{
|
||||
return DeleteFile(new ES3Settings(), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Deletes a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
public IEnumerator DeleteFile(string filePath)
|
||||
{
|
||||
return DeleteFile(new ES3Settings(filePath), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Deletes a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
public IEnumerator DeleteFile(string filePath, string user)
|
||||
{
|
||||
return DeleteFile(new ES3Settings(filePath), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Deletes a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
public IEnumerator DeleteFile(string filePath, string user, string password)
|
||||
{
|
||||
return DeleteFile(new ES3Settings(filePath), user, password);
|
||||
}
|
||||
|
||||
/// <summary>Deletes a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator DeleteFile(string filePath, ES3Settings settings)
|
||||
{
|
||||
return DeleteFile(new ES3Settings(filePath, settings), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Deletes a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator DeleteFile(string filePath, string user, ES3Settings settings)
|
||||
{
|
||||
return DeleteFile(new ES3Settings(filePath, settings), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Deletes a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator DeleteFile(string filePath, string user, string password, ES3Settings settings)
|
||||
{
|
||||
return DeleteFile(new ES3Settings(filePath, settings), user, password);
|
||||
}
|
||||
|
||||
private IEnumerator DeleteFile(ES3Settings settings, string user, string password)
|
||||
{
|
||||
Reset();
|
||||
|
||||
var form = CreateWWWForm();
|
||||
form.AddField("apiKey", apiKey);
|
||||
form.AddField("deleteFile", settings.path);
|
||||
form.AddField("user", GetUser(user, password));
|
||||
|
||||
using(var webRequest = UnityWebRequest.Post(url, form))
|
||||
{
|
||||
webRequest.timeout = timeout;
|
||||
|
||||
yield return SendWebRequest(webRequest);
|
||||
HandleError(webRequest, true);
|
||||
}
|
||||
|
||||
isDone = true;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region RenameFile
|
||||
|
||||
/// <summary>Renames a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
public IEnumerator RenameFile(string filePath, string newFilePath)
|
||||
{
|
||||
return RenameFile(new ES3Settings(filePath), new ES3Settings(newFilePath), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Renames a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
public IEnumerator RenameFile(string filePath, string newFilePath, string user)
|
||||
{
|
||||
return RenameFile(new ES3Settings(filePath), new ES3Settings(newFilePath), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Renames a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
public IEnumerator RenameFile(string filePath, string newFilePath, string user, string password)
|
||||
{
|
||||
return RenameFile(new ES3Settings(filePath), new ES3Settings(newFilePath), user, password);
|
||||
}
|
||||
|
||||
/// <summary>Renames a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator RenameFile(string filePath, string newFilePath, ES3Settings settings)
|
||||
{
|
||||
return RenameFile(new ES3Settings(filePath, settings), new ES3Settings(newFilePath, settings), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Renames a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator RenameFile(string filePath, string newFilePath, string user, ES3Settings settings)
|
||||
{
|
||||
return RenameFile(new ES3Settings(filePath, settings), new ES3Settings(newFilePath, settings), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Renames a file from the server. An error is *not* returned if the file does not exist.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to delete.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator RenameFile(string filePath, string newFilePath, string user, string password, ES3Settings settings)
|
||||
{
|
||||
return RenameFile(new ES3Settings(filePath, settings), new ES3Settings(newFilePath, settings), user, password);
|
||||
}
|
||||
|
||||
private IEnumerator RenameFile(ES3Settings settings, ES3Settings newSettings, string user, string password)
|
||||
{
|
||||
Reset();
|
||||
|
||||
var form = CreateWWWForm();
|
||||
form.AddField("apiKey", apiKey);
|
||||
form.AddField("renameFile", settings.path);
|
||||
form.AddField("newFilename", newSettings.path);
|
||||
form.AddField("user", GetUser(user, password));
|
||||
|
||||
using(var webRequest = UnityWebRequest.Post(url, form))
|
||||
{
|
||||
webRequest.timeout = timeout;
|
||||
|
||||
yield return SendWebRequest(webRequest);
|
||||
HandleError(webRequest, true);
|
||||
}
|
||||
|
||||
isDone = true;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region DownloadFilenames
|
||||
|
||||
/// <summary>Downloads the names of all of the files on the server. Downloaded filenames are stored in the 'filenames' variable of the ES3Cloud object.</summary>
|
||||
/// <param name="user">The unique name of the user we want to find the filenames of.</param>
|
||||
/// <param name="password">The password of the user we want to find the filenames of.</param>
|
||||
public IEnumerator DownloadFilenames(string user="", string password="")
|
||||
{
|
||||
Reset();
|
||||
|
||||
var form = CreateWWWForm();
|
||||
form.AddField("apiKey", apiKey);
|
||||
form.AddField("getFilenames", "");
|
||||
form.AddField("user", GetUser(user, password));
|
||||
|
||||
using(var webRequest = UnityWebRequest.Post(url, form))
|
||||
{
|
||||
webRequest.timeout = timeout;
|
||||
|
||||
yield return SendWebRequest(webRequest);
|
||||
if(!HandleError(webRequest, false))
|
||||
_data = webRequest.downloadHandler.data;
|
||||
}
|
||||
|
||||
isDone = true;
|
||||
}
|
||||
|
||||
/// <summary>Downloads the names of all of the files on the server. Downloaded filenames are stored in the 'filenames' variable of the ES3Cloud object.</summary>
|
||||
/// <param name="user">The unique name of the user we want to find the filenames of.</param>
|
||||
/// <param name="password">The password of the user we want to find the filenames of.</param>
|
||||
/// <param name="searchPattern">A search pattern containing '%' or '_' wildcards where '%' represents zero, one, or multiple characters, and '_' represents a single character.</param>
|
||||
public IEnumerator SearchFilenames(string searchPattern, string user="", string password="")
|
||||
{
|
||||
Reset();
|
||||
|
||||
var form = CreateWWWForm();
|
||||
form.AddField("apiKey", apiKey);
|
||||
form.AddField("getFilenames", "");
|
||||
form.AddField("user", GetUser(user, password));
|
||||
if (!string.IsNullOrEmpty(searchPattern))
|
||||
form.AddField("pattern", searchPattern);
|
||||
|
||||
using (var webRequest = UnityWebRequest.Post(url, form))
|
||||
{
|
||||
webRequest.timeout = timeout;
|
||||
|
||||
yield return SendWebRequest(webRequest);
|
||||
if (!HandleError(webRequest, false))
|
||||
_data = webRequest.downloadHandler.data;
|
||||
}
|
||||
|
||||
isDone = true;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region DownloadTimestamp
|
||||
|
||||
/// <summary>Downloads the timestamp representing when the server file was last updated. The downloaded timestamp is stored in the 'timestamp' variable of the ES3Cloud object.</summary>
|
||||
public IEnumerator DownloadTimestamp()
|
||||
{
|
||||
return DownloadTimestamp(new ES3Settings(), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Downloads the timestamp representing when the server file was last updated. The downloaded timestamp is stored in the 'timestamp' variable of the ES3Cloud object.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to get the timestamp of.</param>
|
||||
public IEnumerator DownloadTimestamp(string filePath)
|
||||
{
|
||||
return DownloadTimestamp(new ES3Settings(filePath), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Downloads the timestamp representing when the server file was last updated. The downloaded timestamp is stored in the 'timestamp' variable of the ES3Cloud object.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to get the timestamp of.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
public IEnumerator DownloadTimestamp(string filePath, string user)
|
||||
{
|
||||
return DownloadTimestamp(new ES3Settings(filePath), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Downloads the timestamp representing when the server file was last updated. The downloaded timestamp is stored in the 'timestamp' variable of the ES3Cloud object.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to get the timestamp of.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
public IEnumerator DownloadTimestamp(string filePath, string user, string password)
|
||||
{
|
||||
return DownloadTimestamp(new ES3Settings(filePath), user, password);
|
||||
}
|
||||
|
||||
/// <summary>Downloads the timestamp representing when the server file was last updated. The downloaded timestamp is stored in the 'timestamp' variable of the ES3Cloud object.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to get the timestamp of.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator DownloadTimestamp(string filePath, ES3Settings settings)
|
||||
{
|
||||
return DownloadTimestamp(new ES3Settings(filePath, settings), "", "");
|
||||
}
|
||||
|
||||
/// <summary>Downloads the timestamp representing when the server file was last updated. The downloaded timestamp is stored in the 'timestamp' variable of the ES3Cloud object.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to get the timestamp of.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator DownloadTimestamp(string filePath, string user, ES3Settings settings)
|
||||
{
|
||||
return DownloadTimestamp(new ES3Settings(filePath, settings), user, "");
|
||||
}
|
||||
|
||||
/// <summary>Downloads the timestamp representing when the server file was last updated. The downloaded timestamp is stored in the 'timestamp' variable of the ES3Cloud object.</summary>
|
||||
/// <param name="filePath">The relative or absolute path of the file we want to get the timestamp of.</param>
|
||||
/// <param name="user">The unique name of the user this file belongs to, if the file isn't globally accessible.</param>
|
||||
/// <param name="password">The password of the user this file belongs to.</param>
|
||||
/// <param name="settings">The settings we want to use to override the default settings.</param>
|
||||
public IEnumerator DownloadTimestamp(string filePath, string user, string password, ES3Settings settings)
|
||||
{
|
||||
return DownloadTimestamp(new ES3Settings(filePath, settings), user, password);
|
||||
}
|
||||
|
||||
private IEnumerator DownloadTimestamp(ES3Settings settings, string user, string password)
|
||||
{
|
||||
Reset();
|
||||
|
||||
var form = CreateWWWForm();
|
||||
form.AddField("apiKey", apiKey);
|
||||
form.AddField("getTimestamp", settings.path);
|
||||
form.AddField("user", GetUser(user, password));
|
||||
|
||||
using(var webRequest = UnityWebRequest.Post(url, form))
|
||||
{
|
||||
webRequest.timeout = timeout;
|
||||
|
||||
yield return SendWebRequest(webRequest);
|
||||
if(!HandleError(webRequest, false))
|
||||
_data = webRequest.downloadHandler.data;
|
||||
}
|
||||
|
||||
isDone = true;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Internal Methods
|
||||
|
||||
private long DateTimeToUnixTimestamp(DateTime dt)
|
||||
{
|
||||
return Convert.ToInt64((dt.ToUniversalTime() - new DateTime(1970, 1, 1, 0, 0, 0, 0, System.DateTimeKind.Utc)).TotalSeconds);
|
||||
}
|
||||
|
||||
private long GetFileTimestamp(ES3Settings settings)
|
||||
{
|
||||
return DateTimeToUnixTimestamp(ES3.GetTimestamp(settings));
|
||||
}
|
||||
|
||||
protected override void Reset()
|
||||
{
|
||||
_data = null;
|
||||
base.Reset();
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
|
||||
#endif
|
||||
11
Convention/[ES3]/Easy Save 3/Scripts/Web/ES3Cloud.cs.meta
Normal file
11
Convention/[ES3]/Easy Save 3/Scripts/Web/ES3Cloud.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: c74b9ccd292e63843a08e388d949183d
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
148
Convention/[ES3]/Easy Save 3/Scripts/Web/ES3WebClass.cs
Normal file
148
Convention/[ES3]/Easy Save 3/Scripts/Web/ES3WebClass.cs
Normal file
@@ -0,0 +1,148 @@
|
||||
using System.Collections;
|
||||
using System.Collections.Generic;
|
||||
using UnityEngine;
|
||||
using UnityEngine.Networking;
|
||||
|
||||
namespace ES3Internal
|
||||
{
|
||||
public class ES3WebClass
|
||||
{
|
||||
protected string url;
|
||||
protected string apiKey;
|
||||
|
||||
protected List<KeyValuePair<string,string>> formData = new List<KeyValuePair<string, string>>();
|
||||
protected UnityWebRequest _webRequest = null;
|
||||
|
||||
|
||||
public bool isDone = false;
|
||||
public float uploadProgress
|
||||
{
|
||||
get
|
||||
{
|
||||
if(_webRequest == null)
|
||||
return 0;
|
||||
else
|
||||
return _webRequest.uploadProgress;
|
||||
}
|
||||
}
|
||||
|
||||
public float downloadProgress
|
||||
{
|
||||
get
|
||||
{
|
||||
if(_webRequest == null)
|
||||
return 0;
|
||||
else
|
||||
return _webRequest.downloadProgress;
|
||||
}
|
||||
}
|
||||
|
||||
#region Error Handling
|
||||
|
||||
/// <summary>An error message, if an error occurred.</summary>
|
||||
public string error = null;
|
||||
/// <summary>This is set to true if an error occurred while performing an operation.</summary>
|
||||
public bool isError{ get{ return !string.IsNullOrEmpty(error) || errorCode > 0; } }
|
||||
/// <summary>The error code relating to the error, if one occurred. If it's a server error, this will return the HTTP error code.</summary>
|
||||
public long errorCode = 0;
|
||||
|
||||
public static bool IsNetworkError(UnityWebRequest www)
|
||||
{
|
||||
#if UNITY_2020_1_OR_NEWER
|
||||
return www.result == UnityWebRequest.Result.ConnectionError;
|
||||
#else
|
||||
return www.isNetworkError;
|
||||
#endif
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
protected ES3WebClass(string url, string apiKey)
|
||||
{
|
||||
this.url = url;
|
||||
this.apiKey = apiKey;
|
||||
}
|
||||
|
||||
#region Other Methods
|
||||
|
||||
/// <summary>Adds POST data to any requests sent by this ES3Cloud object. Use this if you are sending data to a custom script on your server.</summary>
|
||||
/// <param name="fieldName">The name of the POST field we want to add.</param>
|
||||
/// <param name="value">The string value of the POST field we want to add.</param>
|
||||
public void AddPOSTField(string fieldName, string value)
|
||||
{
|
||||
formData.Add(new KeyValuePair<string, string>(fieldName, value));
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Internal Methods
|
||||
|
||||
protected string GetUser(string user, string password)
|
||||
{
|
||||
if(string.IsNullOrEmpty(user))
|
||||
return "";
|
||||
// Final user string is a combination of the username and password, and hashed if encryption is enabled.
|
||||
if(!string.IsNullOrEmpty(password))
|
||||
user += password;
|
||||
|
||||
#if !DISABLE_ENCRYPTION && !DISABLE_HASHING
|
||||
user = ES3Internal.ES3Hash.SHA1Hash(user);
|
||||
#endif
|
||||
return user;
|
||||
}
|
||||
|
||||
protected WWWForm CreateWWWForm()
|
||||
{
|
||||
var form = new WWWForm();
|
||||
foreach(var kvp in formData)
|
||||
form.AddField(kvp.Key, kvp.Value);
|
||||
return form;
|
||||
}
|
||||
|
||||
/* Checks if an error occurred and sets relevant details, and returns true if an error did occur */
|
||||
protected bool HandleError(UnityWebRequest webRequest, bool errorIfDataIsDownloaded)
|
||||
{
|
||||
if(IsNetworkError(webRequest))
|
||||
{
|
||||
errorCode = 1;
|
||||
error = "Error: " + webRequest.error;
|
||||
}
|
||||
else if(webRequest.responseCode >= 400)
|
||||
{
|
||||
errorCode = webRequest.responseCode;
|
||||
if(string.IsNullOrEmpty(webRequest.downloadHandler.text))
|
||||
error = string.Format("Server returned {0} error with no message", webRequest.responseCode);
|
||||
else
|
||||
error = webRequest.downloadHandler.text;
|
||||
}
|
||||
else if(errorIfDataIsDownloaded && webRequest.downloadedBytes > 0)
|
||||
{
|
||||
errorCode = 2;
|
||||
error = "Server error: '" + webRequest.downloadHandler.text + "'";
|
||||
}
|
||||
else
|
||||
return false;
|
||||
return true;
|
||||
}
|
||||
|
||||
protected IEnumerator SendWebRequest(UnityWebRequest webRequest)
|
||||
{
|
||||
_webRequest = webRequest;
|
||||
#if !UNITY_2017_2_OR_NEWER
|
||||
yield return webRequest.Send();
|
||||
#else
|
||||
yield return webRequest.SendWebRequest();
|
||||
#endif
|
||||
}
|
||||
|
||||
protected virtual void Reset()
|
||||
{
|
||||
error = null;
|
||||
errorCode = 0;
|
||||
isDone = false;
|
||||
}
|
||||
|
||||
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
11
Convention/[ES3]/Easy Save 3/Scripts/Web/ES3WebClass.cs.meta
Normal file
11
Convention/[ES3]/Easy Save 3/Scripts/Web/ES3WebClass.cs.meta
Normal file
@@ -0,0 +1,11 @@
|
||||
fileFormatVersion: 2
|
||||
guid: 63fc8a5b1df09ea4f9ae3179c50655e3
|
||||
MonoImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
defaultReferences: []
|
||||
executionOrder: 0
|
||||
icon: {instanceID: 0}
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
Reference in New Issue
Block a user