チェンジセット 1639 (default、framework/trunk/WebLibrary/Sources/UI/WebControls/FileUpload.cs)

日時:

2024/02/14 3:25:54 (8ヵ月前)

更新者:

hizuya@…

ログメッセージ:

• アップロードされたファイルを保持する機能を追加。

ファイル:

• framework/trunk/WebLibrary/Sources/UI/WebControls/FileUpload.cs (更新) (10個の差分)

framework/trunk/WebLibrary/Sources/UI/WebControls/FileUpload.cs

@@ -24 +24 @@
 {
     using System;
+    using System.Collections.Generic;
+    using System.Collections.ObjectModel;
     using System.Collections.Specialized;
     using System.ComponentModel;
+    using System.Diagnostics;
+    using System.IO;
     using System.Web;
     using System.Web.UI;
@@ -31 +35 @@
 
     /// <summary>
-    /// ユーザーがファイルを選択してサーバーにアップロードするための
-    /// テキスト ボックス コントロールと参照ボタンを表示します。
+    /// ユーザーがファイルを選択してサーバーにアップロードするための参照ボタンを表示します。
     /// </summary>
     [WebDescription("Description_FileUpload")]
@@ -61 +64 @@
         private const string ValidationGroupKey = "ValidationGroup";
 
+        /// <summary>
+        /// <see cref="CachePostedFile"/> プロパティ用のキー。
+        /// </summary>
+        private const string CachePostedFileKey = "CachePostedFile";
+
 
         /// <summary>
@@ -66 +74 @@
         /// </summary>
         private static readonly object EventFileSelectedKey = new object();
+
+        /// <summary>
+        /// 空の <see cref="HttpPostedFile"/> の配列。
+        /// </summary>
+        private static readonly HttpPostedFile[] EmptyPostedFiles = new HttpPostedFile[0];
+
+
+        /// <summary>
+        /// キャッシュしたファイルのコレクション。
+        /// </summary>
+        private CachedPostedFileCollection cachedPostedFiles;
+
+        /// <summary>
+        /// ファイルの情報をクリアするかどうか。
+        /// </summary>
+        private bool clearFiles;
 
 
@@ -204 +228 @@
         }
 
+        /// <summary>
+        /// <see cref="FileUpload"/> コントロールを使用してアップロードされたファイルを
+        /// 保持し続けるかどうかを設定または取得します。
+        /// </summary>
+        /// <value>
+        /// ポストされたファイルを保持する場合は <see langword="true"/>。
+        /// それ以外の場合は <see langword="false"/>。
+        /// 既定値は <see langword="false"/>。
+        /// </value>
+        /// <remarks>
+        /// <para>
+        /// このプロパティを <see langword="true"/> に設定すると、
+        /// アップロードが行われたポストバック時にアップロードされたファイルをビューステートに保持し、
+        /// 次回のポストバック時にアップロードされたファイルの内容にアクセスできるようになります。
+        /// </para>
+        /// <para>
+        /// 保持しているファイルをクリアしたい場合は <see cref="ClearFiles"/>
+        /// メソッドを呼び出します。
+        /// </para>
+        /// </remarks>
+        [Themeable(false)]
+        [DefaultValue(false)]
+        [WebCategory("Behavior")]
+        [WebDescription("Description_CachePostedFile")]
+        public virtual bool CachePostedFile
+        {
+            get
+            {
+                return (bool)(ViewState[CachePostedFileKey] ?? false);
+            }
+
+            set
+            {
+                ViewState[CachePostedFileKey] = value;
+            }
+        }
+
+
+        /// <summary>
+        /// <see cref="FileUpload"/> コントロールを使用してアップロードされたファイルに格納されているバイトの配列を取得します。
+        /// </summary>
+        /// <value>
+        /// アップロードされたファイルに格納されていた <see cref="byte"/> 配列。
+        /// </value>
+        /// <remarks>
+        /// <see cref="CachePostedFile"/> が <see langword="true"/> の場合、
+        /// 一度格納されたファイルはポストバックを繰り返しても保持されます。
+        /// この場合、このプロパティは最後にアップロードされた時のファイルに格納されていたバイト配列を返します。
+        /// </remarks>
+        [Browsable(false)]
+        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
+        public new byte[] FileBytes
+        {
+            get
+            {
+                HttpPostedFile postedFile = PostedFile;
+                return postedFile != null
+                    ? Reflections.HttpInputStream.GetAsByteArray(postedFile.InputStream)
+                    : new byte[0];
+            }
+        }
+
+        /// <summary>
+        /// <see cref="FileUpload"/> コントロールを使用してアップロードされたファイルを指す
+        /// <see cref="Stream"/> オブジェクトを取得します。
+        /// </summary>
+        /// <value>
+        /// <see cref="FileUpload"/> を使用してアップロードされたファイルを指す <see cref="Stream"/>。
+        /// </value>
+        /// <remarks>
+        /// <see cref="CachePostedFile"/> が <see langword="true"/> の場合、
+        /// 一度格納されたファイルはポストバックを繰り返しても保持されます。
+        /// この場合、このプロパティは最後にアップロードされた時のファイルを指すストリームを返します。
+        /// </remarks>
+        [Browsable(false)]
+        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
+        [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+        public new Stream FileContent
+        {
+            get
+            {
+                HttpPostedFile postedFile = PostedFile;
+                return postedFile != null
+                    ? postedFile.InputStream
+                    : Stream.Null;
+            }
+        }
+
+        /// <summary>
+        /// ファイルが <see cref="FileUpload"/> コントロールに格納されているかどうかを示す値を取得します。
+        /// </summary>
+        /// <value>
+        /// ファイルが <see cref="FileUpload"/> コントロールに格納されている場合は <see langword="true"/>。
+        /// それ以外の場合は <see langword="false"/>。
+        /// ASP.NET の標準の実装とは異なり、空のファイルをアップロードした場合でも <see langword="true"/> を返します。
+        /// また、ファイルのストリームをクローズした後でも <see langword="true"/> を返しますが、
+        /// ファイルの長さ (<see cref="HttpPostedFile.ContentLength"/>) は <c>0</c> となります。
+        /// </value>
+        /// <remarks>
+        /// <see cref="CachePostedFile"/> が <see langword="true"/> の場合、
+        /// 一度格納されたファイルはポストバックを繰り返しても保持されます。
+        /// この場合、このプロパティは <see langword="true"/> を返します。
+        /// </remarks>
+        [Browsable(false)]
+        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
+        public new bool HasFile
+        {
+            get
+            {
+                return PostedFile != null;
+            }
+        }
+
+        /// <summary>
+        /// ファイルが <see cref="FileUpload"/> コントロールに格納されているかどうかを示す値を取得します。
+        /// </summary>
+        /// <value>
+        /// ファイルが <see cref="FileUpload"/> コントロールに格納されている場合は <see langword="true"/>。
+        /// それ以外の場合は <see langword="false"/>。
+        /// ASP.NET の標準の実装とは異なり、空のファイルをアップロードした場合でも <see langword="true"/> を返します。
+        /// また、ファイルのストリームをクローズした後でも <see langword="true"/> を返しますが、
+        /// ファイルの長さ (<see cref="HttpPostedFile.ContentLength"/>) は <c>0</c> となります。
+        /// </value>
+        /// <remarks>
+        /// <see cref="CachePostedFile"/> が <see langword="true"/> の場合、
+        /// 一度格納されたファイルはポストバックを繰り返しても保持されます。
+        /// この場合、このプロパティは <see langword="true"/> を返します。
+        /// </remarks>
+        [Browsable(false)]
+        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
+        public new bool HasFiles
+        {
+            get
+            {
+                return PostedFiles.Count > 0;
+            }
+        }
+
+        /// <summary>
+        /// <see cref="FileUpload"/> コントロールを使用してアップロードされたファイルの基になる
+        /// <see cref="HttpPostedFile"/> オブジェクトを取得します。
+        /// </summary>
+        /// <value>
+        /// <see cref="FileUpload"/> コントロールを使用してアップロードされた <see cref="HttpPostedFile"/> オブジェクト。
+        /// <see cref="HasFile"/> プロパティが <see langword="false"/>
+        /// を返す場合は <see langword="null"/>です。
+        /// </value>
+        /// <remarks>
+        /// <see cref="CachePostedFile"/> が <see langword="true"/> の場合、
+        /// 一度格納されたファイルはポストバックを繰り返しても保持されます。
+        /// この場合、このプロパティは最後にアップロードされた時のファイルを返します。
+        /// </remarks>
+        [Browsable(false)]
+        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
+        public new HttpPostedFile PostedFile
+        {
+            get
+            {
+                // クリアされている場合
+                if (clearFiles)
+                {
+                    return null;
+                }
+
+                Page page = Page;
+                if (page == null || !page.IsPostBack)
+                {
+                    return null;
+                }
+
+                // キャッシュされていればキャッシュから返す
+                if (cachedPostedFiles != null)
+                {
+                    return cachedPostedFiles.PostedFile;
+                }
+
+                HttpPostedFile postedFile = base.PostedFile;
+                return IsValidPostedFile(postedFile)
+                    ? postedFile
+                    : null;
+            }
+        }
+
+        /// <summary>
+        /// <see cref="FileUpload"/> コントロールを使用してアップロードされたファイルのコレクションを取得します。
+        /// </summary>
+        /// <value>
+        /// <see cref="FileUpload"/> コントロールを使用してアップロードされたファイルのコレクション。
+        /// <see cref="HasFiles"/> プロパティが <see langword="false"/>
+        /// を返す場合は空のコレクションです。
+        /// </value>
+        /// <remarks>
+        /// <see cref="CachePostedFile"/> が <see langword="true"/> の場合、
+        /// 一度格納されたファイルはポストバックを繰り返しても保持されます。
+        /// この場合、このプロパティは最後にアップロードされた時のファイルのコレクションを返します。
+        /// </remarks>
+        [Browsable(false)]
+        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
+        public new IList<HttpPostedFile> PostedFiles
+        {
+            get
+            {
+                // クリアされている場合
+                if (clearFiles)
+                {
+                    return EmptyPostedFiles;
+                }
+
+                // キャッシュされていればキャッシュから返す
+                if (cachedPostedFiles != null)
+                {
+                    return cachedPostedFiles.PostedFiles;
+                }
+
+                IList<HttpPostedFile> postedFiles = base.PostedFiles;
+                return IsValidPostedFiles(postedFiles)
+                    ? postedFiles
+                    : EmptyPostedFiles;
+            }
+        }
+
+
+        /// <summary>
+        /// このコントロールに格納されているファイル情報を削除します。
+        /// </summary>
+        public void ClearFiles()
+        {
+            cachedPostedFiles = null;
+            clearFiles = true;
+        }
+
 
         #region IPostBackDataHandler メンバ
@@ -237 +492 @@
 
         /// <summary>
+        /// <see cref="FileUpload"/> コントロールの保存された状態を読み込みます。
+        /// </summary>
+        /// <param name="savedState">
+        /// <see cref="FileUpload"/> の保存された状態を格納している
+        /// <see cref="object"/>。
+        /// </param>
+        protected override void LoadViewState(object savedState)
+        {
+            if (savedState == null)
+            {
+                return;
+            }
+
+            Pair state = (Pair)savedState;
+
+            // 親を呼び出す
+            base.LoadViewState(state.First);
+
+            if (state.Second != null)
+            {
+                cachedPostedFiles = CachedPostedFileCollection.CreateFromViewState(state.Second);
+            }
+        }
+
+        /// <summary>
+        /// <see cref="FileUpload"/> コントロールの状態を格納します。
+        /// </summary>
+        /// <returns>
+        /// <see cref="FileUpload"/> の保存された状態を格納しているオブジェクト。
+        /// </returns>
+        protected override object SaveViewState()
+        {
+            // 親を呼び出す
+            Pair state = new Pair
+            {
+                First = base.SaveViewState(),
+            };
+
+            // 保持するデータが有る場合
+            if (EnsurePostedFileCache())
+            {
+                state.Second = cachedPostedFiles.ToViewState();
+            }
+
+            if (state.First == null && state.Second == null)
+            {
+                return null;
+            }
+
+            return state;
+        }
+
+        /// <summary>
         /// コントロールのポストバック データを処理します。
         /// </summary>
@@ -256 +564 @@
             }
 
-            // ファイルがポストされていれば true を返す
-            HttpPostedFile postedFile = PostedFile;
-            return postedFile != null
-                && (!string.IsNullOrEmpty(postedFile.FileName) || postedFile.ContentLength > 0);
+            // ファイルがポストされていなければ false を返す
+            if (!IsValidPostedFile(base.PostedFile))
+            {
+                return false;
+            }
+
+            // ポストされたファイルが有るのでキャッシュをクリアしてキャッシュし直す
+            cachedPostedFiles = null;
+            EnsurePostedFileCache();
+
+            return true;
         }
 
@@ -360 +675 @@
             if (page != null)
             {
+                string onChange = null;
+                if (HasAttributes)
+                {
+                    onChange = Attributes["onchange"];
+                    if (onChange != null)
+                    {
+                        onChange = ClientScriptUtility.EnsureEndWithSemiColon(onChange);
+                        Attributes.Remove("onchange");
+                    }
+                }
+
+                onChange = ClientScriptUtility.MergeScript(onChange, GetOnClientChanged(), false);
+
                 if (AutoPostBack)
                 {
-                    string onChange = null;
-                    if (HasAttributes)
-                    {
-                        onChange = Attributes["onchange"];
-                        if (onChange != null)
-                        {
-                            onChange = ClientScriptUtility.EnsureEndWithSemiColon(onChange);
-                            Attributes.Remove("onchange");
-                        }
-                    }
-
                     PostBackOptions options = new PostBackOptions(this, string.Empty);
                     if (CausesValidation)
@@ -385 +702 @@
                     }
 
-                    writer.AddAttribute(
-                        HtmlTextWriterAttribute.Onchange,
-                        ClientScriptUtility.MergeScript(onChange, page.ClientScript.GetPostBackEventReference(options, true), false));
+                    onChange = ClientScriptUtility.MergeScript(onChange, page.ClientScript.GetPostBackEventReference(options, true), false);
                 }
                 else
                 {
+                    // GetPostBackEventReference を呼び出していないので登録する
                     page.ClientScript.RegisterForEventValidation(UniqueID, string.Empty);
+                }
+
+                if (onChange != null)
+                {
+                    writer.AddAttribute(HtmlTextWriterAttribute.Onchange, onChange);
                 }
             }
@@ -403 +724 @@
             base.AddAttributesToRender(writer);
         }
+
+        /// <summary>
+        /// クライアントサイドで実行される <c>onchange</c> イベントハンドラを取得します。
+        /// </summary>
+        /// <returns>
+        /// クライアントサイドで実行される <c>onchange</c> イベントハンドラ。
+        /// </returns>
+        protected virtual string GetOnClientChanged()
+        {
+            return null;
+        }
+
+        /// <summary>
+        /// 有効なポストされたファイルかどうかを返します。
+        /// </summary>
+        /// <param name="postedFile"><see cref="HttpPostedFile"/>。</param>
+        /// <returns>
+        /// 有効な場合は <see langword="true"/>。
+        /// それ以外の場合は <see langword="false"/>。
+        /// </returns>
+        private static bool IsValidPostedFile(HttpPostedFile postedFile)
+        {
+            return postedFile != null
+                && (!string.IsNullOrEmpty(postedFile.FileName) || postedFile.ContentLength > 0);
+        }
+
+        /// <summary>
+        /// 有効なポストされたファイルかどうかを返します。
+        /// </summary>
+        /// <param name="postedFiles"><see cref="HttpPostedFile"/> のリスト。</param>
+        /// <returns>
+        /// 有効な場合は <see langword="true"/>。
+        /// それ以外の場合は <see langword="false"/>。
+        /// </returns>
+        private static bool IsValidPostedFiles(IList<HttpPostedFile> postedFiles)
+        {
+            if (postedFiles == null)
+            {
+                return false;
+            }
+
+            // おそらく、ポストバックではない場合
+            if (postedFiles.Count == 0)
+            {
+                return true;
+            }
+
+            // 実際は未指定 (ポストされなかった場合) だった場合でも、一つデータが存在する
+            if (postedFiles.Count == 1 && !IsValidPostedFile(postedFiles[0]))
+            {
+                return false;
+            }
+
+            return true;
+        }
+
+        /// <summary>
+        /// ポストされたファイルが保持されていない場合に保持します。
+        /// </summary>
+        /// <returns>
+        /// 保持するデータがある場合は <see langword="true"/>。
+        /// それ以外の場合は <see langword="false"/>。
+        /// </returns>
+        private bool EnsurePostedFileCache()
+        {
+            // クリアされていれば保持しない
+            if (clearFiles)
+            {
+                return false;
+            }
+
+            // 保持する設定になっていない場合
+            if (!CachePostedFile)
+            {
+                return false;
+            }
+
+            // ポストバック時ではない場合は保持しない (そもそもアップロードファイルが無い)
+            Page page = Page;
+            if (page != null && !page.IsPostBack)
+            {
+                return false;
+            }
+
+            // 既に保持するデータを準備済の場合
+            if (cachedPostedFiles != null)
+            {
+                return true;
+            }
+
+            UpdatePostedFileCache();
+            return cachedPostedFiles != null;
+        }
+
+        /// <summary>
+        /// ポストされたファイルのキャッシュ情報を更新します。
+        /// </summary>
+        private void UpdatePostedFileCache()
+        {
+            cachedPostedFiles = CachedPostedFileCollection.CreateFrom(base.PostedFiles);
+        }
+
+
+
+        /// <summary>
+        /// アップロードされたファイルの保存情報を保持するクラスです。
+        /// </summary>
+        [Serializable]
+        [DebuggerDisplay(@"\{FileName = {fileName}\}")]
+        private sealed class CachedPostedFile
+        {
+            /// <summary>
+            /// ファイル名。
+            /// </summary>
+            [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+            private readonly string fileName;
+
+            /// <summary>
+            /// MIME コンテンツタイプ。
+            /// </summary>
+            [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+            private readonly string contentType;
+
+            /// <summary>
+            /// ファイルの内容を表すバイト配列。
+            /// </summary>
+            /// <remarks>
+            /// ファイルが空の場合は <see langword="null"/>。
+            /// </remarks>
+            [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+            private readonly byte[] contents;
+
+
+            /// <summary>
+            /// インスタンスを作成します。
+            /// </summary>
+            /// <param name="postedFile">ポストされたファイル。</param>
+            internal CachedPostedFile(HttpPostedFile postedFile)
+            {
+                fileName = Path.GetFileName(postedFile.FileName);
+                contentType = postedFile.ContentType;
+                contents = Reflections.HttpInputStream.GetAsByteArray(postedFile.InputStream);
+            }
+
+
+            /// <summary>
+            /// ファイル名を取得します。
+            /// </summary>
+            /// <value>
+            /// ファイル名。
+            /// </value>
+            internal string FileName
+            {
+                get
+                {
+                    return fileName;
+                }
+            }
+
+            /// <summary>
+            /// MIME コンテンツタイプを取得します。
+            /// </summary>
+            /// <value>
+            /// MIME コンテンツタイプ。
+            /// </value>
+            internal string ContentType
+            {
+                get
+                {
+                    return contentType;
+                }
+            }
+
+            /// <summary>
+            /// ファイルの内容を表すバイト配列を取得します。
+            /// </summary>
+            /// <value>
+            /// ファイルの内容を表すバイト配列。
+            /// ファイルが空の場合は <see langword="null"/>。
+            /// </value>
+            internal byte[] Contents
+            {
+                get
+                {
+                    return contents;
+                }
+            }
+        }
+
+
+
+        /// <summary>
+        /// アップロードされたファイルの保存情報を保持するクラスです。
+        /// </summary>
+        [DebuggerDisplay(@"Count = {Count}")]
+        private sealed class CachedPostedFileCollection :
+            Collection<CachedPostedFile>
+        {
+            /// <summary>
+            /// このコレクションの要素を元に作成された <see cref="HttpPostedFile"/> の読み取り専用のリスト。
+            /// </summary>
+            private IList<HttpPostedFile> postedFiles;
+
+
+            /// <summary>
+            /// インスタンスを作成します。
+            /// </summary>
+            /// <param name="list"><see cref="FileUpload.CachePostedFile"/> の配列。</param>
+            private CachedPostedFileCollection(CachedPostedFile[] list)
+                : base(list)
+            {
+                Debug.Assert(list.Length > 0, "Invalid count");
+            }
+
+
+            /// <summary>
+            /// 格納されたファイルを取得します。
+            /// </summary>
+            /// <value>
+            /// 格納されたファイル。
+            /// </value>
+            internal HttpPostedFile PostedFile
+            {
+                get
+                {
+                    return PostedFiles[0];
+                }
+            }
+
+            /// <summary>
+            /// 格納されたファイルのコレクションを取得します。
+            /// </summary>
+            /// <value>
+            /// 格納されたファイルのコレクション。
+            /// </value>
+            internal IList<HttpPostedFile> PostedFiles
+            {
+                get
+                {
+                    if (postedFiles == null)
+                    {
+                        HttpPostedFile[] newPostedFiles = new HttpPostedFile[Count];
+                        for (int i = 0; i < Count; i++)
+                        {
+                            CachedPostedFile cachedPostedFile = this[i];
+
+                            // 長さが 0 のファイルの場合は Contents が null
+                            byte[] contents = cachedPostedFile.Contents;
+
+                            newPostedFiles[i]
+                                = Reflections.HttpPostedFile.CreateInstance(
+                                    cachedPostedFile.FileName,
+                                    cachedPostedFile.ContentType,
+                                    Reflections.HttpInputStream.CreateInstance(
+                                        contents != null
+                                            ? Reflections.HttpRawUploadedContent.CreateInstance(contents)
+                                            : null,
+                                        0,
+                                        contents != null
+                                            ? contents.Length
+                                            : 0));
+                        }
+
+                        postedFiles = Array.AsReadOnly(newPostedFiles);
+                    }
+
+                    return postedFiles;
+                }
+            }
+
+            /// <summary>
+            /// ポストされたファイルのリストからインスタンスを作成して返します。
+            /// </summary>
+            /// <param name="postedFiles">ポストされたファイルのリスト。</param>
+            /// <returns>
+            /// キャッシュするデータのコレクション。
+            /// 有効なポストされたファイルが無い場合は <see langword="null"/>。
+            /// </returns>
+            internal static CachedPostedFileCollection CreateFrom(IList<HttpPostedFile> postedFiles)
+            {
+                if (postedFiles == null || postedFiles.Count == 0 || !IsValidPostedFiles(postedFiles))
+                {
+                    return null;
+                }
+
+                CachedPostedFile[] cachedPostedFiles = new CachedPostedFile[postedFiles.Count];
+                for (int i = 0; i < postedFiles.Count; i++)
+                {
+                    cachedPostedFiles[i] = new CachedPostedFile(postedFiles[i]);
+                }
+
+                return new CachedPostedFileCollection(cachedPostedFiles);
+            }
+
+            /// <summary>
+            /// ビューステートに保存したデータからインスタンスを作成します。
+            /// </summary>
+            /// <param name="viewState">ビューステート。</param>
+            /// <returns>
+            /// <paramref name="viewState"/> を元に作成したインスタンス。
+            /// </returns>
+            internal static CachedPostedFileCollection CreateFromViewState(object viewState)
+            {
+                return new CachedPostedFileCollection((CachedPostedFile[])viewState);
+            }
+
+            /// <summary>
+            /// ビューステートに保存するデータを取得します。
+            /// </summary>
+            /// <returns>
+            /// ビューステートに保存するデータ。
+            /// </returns>
+            internal object ToViewState()
+            {
+                // 実体は配列 (コンストラクタで渡した配列)
+                return Items;
+            }
+        }
     }
 }