1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2005-2009. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
%%
%% Description: This module impements a temporary process that
%% performes progress reporting during file transfer calling a user
%% defined callback function. Its life span is as long as the ftp connection
%% processes that spawned it lives. The purpose of this process is to
%% shild the ftp connection process from errors and time consuming operations
%% in the user defined callback function.
-module(ftp_progress).
%% Internal API
-export([start_link/1, report/2, stop/1]).
%% Spawn export
-export([init/1]).
-include_lib("kernel/include/file.hrl").
-record(progress, {
file, % string()
cb_module, % atom()
cb_function, % atom()
init_progress_term, % term()
current_progress_term % term()
}).
%%%=========================================================================
%%% Internal application API
%%%=========================================================================
%%--------------------------------------------------------------------------
%% start_link(Options) -> ignore | pid()
%% Options = ignore | {CBModule, CBFunction, InitProgressTerm}
%%
%% Description: Starts the progress report process unless progress reporting
%% should not be performed.
%%--------------------------------------------------------------------------
start_link(ignore) ->
ignore;
start_link(Options) ->
spawn_link(?MODULE, init, [Options]).
%%--------------------------------------------------------------------------
%% report_progress(Pid, Report) -> _
%% Pid = pid()
%% Report = {local_file, File} | {remote_file, File} |
%% {transfer_size, Size}
%% Size = integer()
%%
%% Description: Reports progress to the reporting process that calls the
%% user defined callback function.
%%--------------------------------------------------------------------------
report(Pid, Report) ->
Pid ! {progress_report, Report}.
%%--------------------------------------------------------------------------
%% stop(Pid) -> _
%% Pid = pid()
%%
%% Description:
%%--------------------------------------------------------------------------
stop(Pid) ->
Pid ! stop.
%%%=========================================================================
%%% Internal functions
%%%=========================================================================
init(Options) ->
loop(progress(Options)).
loop(Progress) ->
receive
{progress_report, Report} ->
NewProgress = report_progress(Report, Progress),
loop(NewProgress);
stop ->
ok
end.
progress({CBModule, CBFunction, InitProgressTerm}) when is_atom(CBModule),
is_atom(CBFunction) ->
#progress{cb_module = CBModule,
cb_function = CBFunction,
init_progress_term = InitProgressTerm,
current_progress_term = InitProgressTerm}.
report_progress({local_file, File}, Progress) ->
{ok, FileInfo} = file:read_file_info(File),
report_progress({file_size, FileInfo#file_info.size},
Progress#progress{file = File});
report_progress({remote_file, File}, Progress) ->
report_progress({file_size, unknown}, Progress#progress{file = File});
report_progress(Size, #progress{file = File,
cb_module = CBModule,
cb_function = CBFunction,
current_progress_term = Term,
init_progress_term = InitTerm} = Progress) ->
NewProgressTerm = CBModule:CBFunction(Term, File, Size),
case Size of
{transfer_size, 0} ->
%% Transfer is compleat reset initial values
Progress#progress{current_progress_term = InitTerm,
file = undefined};
_ ->
Progress#progress{current_progress_term = NewProgressTerm}
end.
|
