.TH ncftpspooler 1 "NcFTP Software" ncftpspooler
.SH "نام (NAME)"
ncftpspooler \- دیمن پردازش پس‌زمینه صف کارهای FTP
.SH "خلاصه دستور (SYNOPSIS)"
.PP
.B ncftpspooler
\-d
.RI [ "گزینه‌ها" ]
.PP
.B ncftpspooler
\-l
.RI [ "گزینه‌ها" ]
.\"-------
.SH "گزینه‌ها (OPTIONS)"
.\"-------
.SS "فلگ‌های خط فرمان:"
.TP 8
.B "-d"
آغاز پردازش پس‌زمینه کارهای FTP در دایرکتوری تعیین‌شده برای صف کارهای FTP.
.TP 8
.BI \-q " XX"
استفاده از این گزینه برای تعیین دایرکتوری مورد نظر به عنوان صف کارهای FTP به جای دایرکتوری پیش‌فرض،
.IR /var/spool/ncftp .
.TP 8
.BI \-o " XX"
استفاده از این گزینه برای تعیین نام فایل گزارش (log).
به طور پیش‌فرض (و تا حدی نامناسب) برنامه فقط از فایلی با نام
.I log
در دایرکتوری صف کارها استفاده می‌کند.
اگر نیازی به ثبت گزارش ندارید، با این گزینه مقدار
.I /dev/null
را مشخص کنید.
.TP 8
.B \-l
فهرست کردن محتویات دایرکتوری صف کارها.
.TP 8
.BI \-s " XX"
هنگامی که صف کارها خالی است، برنامه ۱۲۰ ثانیه در حالت خواب می‌ماند و سپس دوباره بررسی می‌کند تا ببیند آیا کار جدیدی ثبت شده است یا خیر.
با این گزینه می‌توانید تعداد ثانیه‌های این تاخیر را تغییر دهید.
.\"-------
.SH "توضیحات (DESCRIPTION)"
.\"-------
.PP
برنامه
.I ncftpspooler
بر پایه برنامه
.I ncftpbatch
توسعه یافته است.
برنامه
.I ncftpbatch
در ابتدا به عنوان یک «اسپولر شخصی FTP» طراحی شده بود که یک کار پس‌زمینه را برای کاربری مشخص پردازش می‌کرد و پس از اتمام خارج می‌شد؛
اما برنامه
.I ncftpspooler
یک «اسپولر سراسری FTP» است که همیشه در حال اجرا می‌ماند و کارهای پس‌زمینه را به محض ارسال و ثبت پردازش می‌کند.
.PP
دایرکتوری صف کارها برای فایل‌های متنی با نام‌گذاری و قالب‌بندی ویژه پایش می‌شود.
هر فایل به عنوان یک کار FTP عمل می‌کند.
نام فایل کار شامل نوع کار FTP
.RI ( get " یا " put )،
یک برچسب زمانی که نشان‌دهنده زودترین زمان ممکن برای پردازش کار است،
و به صورت اختیاری برخی اطلاعات تکمیلی برای تسهیل ایجاد فایل‌های کار یکتا
(مانند یک شماره ترتیبی) است.
محتوای فایل‌های کار شامل اطلاعاتی نظیر ماشین سرور مقصد برای اتصال FTP، نام کاربری، گذرواژه، مسیر راه دور و موارد دیگر است.
.PP
دایرکتوری صف کارهای شما باید برای کاربری که قصد دارید
.I ncftpspooler
را با آن اجرا کنید دارای مجوز خواندن و نوشتن باشد تا بتواند فایل‌های کار را در صف حذف کرده یا تغییر نام دهد.
.PP
مهم‌تر از آن، کاربری که برنامه را اجرا می‌کند باید دسترسی‌های کافی برای دسترسی به فایل‌های محلی مرتبط با انتقال FTP را داشته باشد.
برای نمونه، اگر قرار است اسپولر کارهایی را پردازش کند که فایل‌ها را روی سرورهای دوردست بارگذاری (upload) می‌کنند، این کاربر نیازمند مجوز خواندن روی فایل‌های محلی است که باید بارگذاری شوند (و همچنین مجوز دسترسی به دایرکتوری‌های والد آن‌ها).
به همین ترتیب، اگر اسپولر قرار است کارهای بارگیری (download) فایل‌ها را پردازش کند، کاربر باید بتواند در دایرکتوری‌های محلی بنویسد.
.PP
پس از آنکه دایرکتوری اسپول خود را با مجوزها و مالکیت مناسب ایجاد کردید، می‌توانید دستور
.I "ncftpspooler\ \-d"
را برای راه‌اندازی دیمن اسپولر اجرا کنید.
اگر می‌خواهید بیش از یک کار FTP را به طور همزمان از همان دایرکتوری صف کارها پردازش کنید، می‌توانید اسپولرهای بیشتری را اجرا کنید.
سپس می‌توانید فایل گزارش را
.RI "(برای نمونه با دستور " "tail\ \-f" " )"
پایش کنید تا روند پیشرفت اسپولر را پیگیری نمایید.
در بیشتر مواقع اسپولر کاری انجام نخواهد داد، مگر اینکه فایل‌های کاری در دایرکتوری صف کارها ظاهر شوند.
.\"-------
.SH "نام‌گذاری فایل‌های کار (JOB FILE NAMES)"
.\"-------
.PP
هنگامی که برنامه
.I ncftpspooler
دایرکتوری صف کارها را پایش می‌کند، تمام فایل‌هایی را که از قواعد نام‌گذاری فایل‌های کار پیروی نمی‌کنند نادیده می‌گیرد.
فایل‌های کار باید دارای پیشوندی با قالب
.I "X\-YYYYMMDD\-hhmmss"
باشند که در آن:
.I X
نشان‌دهنده نوع کار است،
.I YYYY
سال چهاررقمی،
.I MM
شماره دو‌رقمی ماه،
.I DD
روز دورقمی ماه،
.I hh
ساعت دورقمی شبانه‌روز (00\-23)،
.I mm
دقیقه دورقمی،
و
.I ss
ثانیه دورقمی است.
تاریخ و زمان نشان‌دهنده زودترین زمانی است که می‌خواهید کار اجرا شود.
.PP
نوع کار می‌تواند
.I g
برای get (بارگیری از میزبان راه دور)
یا
.I p
برای put (بارگذاری به میزبان راه دور) باشد.
.PP
به عنوان مثال، اگر می‌خواهید بارگذاری در ساعت ۲۳:۴۵ روز ۷ دسامبر ۲۰۰۱ انجام شود، نام فایل کار می‌تواند به این صورت باشد:
.RS 4
.sp
.nf
p-20011207-234500
.fi
.RE
.PP
در عمل، فایل‌های کار شامل اطلاعات تکمیلی نظیر شماره ترتیبی یا شناسه فرایند (PID) نیز می‌شوند.
این کار ایجاد نام‌های یکتا برای فایل‌های کار را آسان‌تر می‌کند.
در ادامه همان مثال، همراه با شناسه فرایند و شماره ترتیبی آورده شده است:
.RS 4
.sp
.nf
p-20011207-234500-1234-2
.fi
.RE
.PP
هنگام ارسال فایل‌های کار به دایرکتوری صف، در صورت افزودن داده‌های اضافی به نام فایل کار، حتماً بعد از بخش
.I hhmmss
از نویسه خط تیره (-) استفاده کنید.
.\"-------
.SH "محتوای فایل‌های کار (JOB FILE CONTENTS)"
.\"-------
.PP
فایل‌های کار، فایل‌های متنی معمولی هستند و می‌توان آن‌ها را به صورت دستی ایجاد کرد.
هر خط فایل یک جفت کلید-مقدار با قالب
.IR "variable" "=" "value" "،"
یا یک خط توضیحات که با نویسه هش
.RI ( "#" )
شروع می‌شود، یا یک خط خالی است.
در ادامه نمونه‌ای از یک فایل کار آورده شده است:
.RS 4
.sp
.nf
# This is a NcFTP spool file entry.
job-name=g-20011016-100656-008299-1
op=get
hostname=ftp.freebsd.org
xtype=I
passive=1
remote-dir=pub/FreeBSD
local-dir=/tmp
remote-file=README.TXT
local-file=readme.txt
.fi
.RE
.PP
فایل‌های کار انعطاف‌پذیر هستند زیرا از قالبی ساده پیروی می‌کنند و پیش‌نیازهای اندکی دارند، اما چند پارامتر اجباری وجود دارد که برای پردازش کار توسط اسپولر باید حتماً درج شوند.
.TP 8
.I op
عملیات (نوع کار) مورد نظر.
مقادیر معتبر عبارتند از
.IR "get" " و " "put" "."
.TP 8
.I hostname
میزبان راه دور برای اتصال FTP.
این مقدار می‌تواند یک نشانی IP یا یک نام DNS (مانند
ftp\.example\.com)
باشد.
.PP
برای یک کار معمولی
.IR get ،
این پارامترها الزامی هستند:
.TP 8
.I remote\-file
مسیر فایلی که باید از سرور راه دور بارگیری شود.
.TP 8
.I local\-file
مسیری که روی سرور محلی برای فایل بارگیری‌شده استفاده می‌شود.
.PP
برای یک کار معمولی
.IR put ،
این پارامترها الزامی هستند:
.TP 8
.I local\-file
مسیر فایلی که باید در سرور راه دور بارگذاری شود.
.TP 8
.I remote\-file
مسیری که روی سرور راه دور برای فایل بارگذاری‌شده استفاده می‌شود.
.PP
برای یک کار بازگشتی (recursive)
.IR get ،
این پارامترها الزامی هستند:
.TP 8
.I remote\-file
مسیر فایل یا دایرکتوری که باید از سرور راه دور بارگیری شود.
.TP 8
.I local\-dir
مسیر دایرکتوری روی سرور محلی برای قرارگیری موارد بارگیری‌شده.
.PP
برای یک کار بازگشتی (recursive)
.IR put ،
این پارامترها الزامی هستند:
.TP 8
.I local\-file
مسیر فایل یا دایرکتوری که باید در سرور راه دور بارگذاری شود.
.TP 8
.I remote\-dir
مسیر دایرکتوری روی سرور راه دور برای قرارگیری موارد بارگذاری‌شده.
.PP
بقیه پارامترها اختیاری هستند.
اسپولر در صورت نیاز تلاش می‌کند مقادیر پیش‌فرض منطقی برای این پارامترها به کار گیرد.
.TP 8
.I user
نام کاربری برای ورود به سرور راه دور.
مقدار پیش‌فرض برای دسترسی مهمان «anonymous» است.
.TP 8
.I pass
گذرواژه مورد استفاده همراه با نام کاربری برای ورود به سرور راه دور.
.TP 8
.I acct
حساب کاربری مورد استفاده همراه با نام کاربری برای ورود به سرور راه دور.
نیاز به مشخص کردن این پارامتر بسیار نادر است.
.TP 8
.I port
شماره پورت برای اتصال به سرور راه دور.
مقدار پیش‌فرض، پورت استاندارد FTP یعنی ۲۱ است.
.TP 8
.I host-ip
نشانی IP مورد استفاده همراه با نام میزبان راه دور برای اتصال به سرور راه دور.
این پارامتر می‌تواند به جای پارامتر
.I hostname
استفاده شود، اما درج یکی از این دو الزامی است.
این پارامتر معمولاً همراه با پارامتر
.I hostname
به عنوان اطلاعات تکمیلی قرار می‌گیرد.
.TP 8
.I xtype
نوع انتقال مورد استفاده.
پیش‌فرض، نوع انتقال باینری (TYPE\ I) است.
مقادیر معتبر عبارتند از
.I I
برای باینری، و
.I A
برای متن ASCII.
.TP 8
.I passive
تعیین استفاده از اتصالات داده مجهول FTP (PASV) یا اتصالات داده فعال FTP (PORT).
مقادیر معتبر عبارتند از
.I 0
برای فعال،
.I 1
برای مجهول،
یا
.I 2
برای تلاش با حالت مجهول و در صورت ناموفق بودن برگشت به حالت فعال.
مقدار پیش‌فرض
.IR 2
است.
.TP 8
.I recursive
برای انتقال کامل درخت‌های دایرکتوری به کار می‌رود.
به طور پیش‌فرض، تنها یک فایل تکی منتقل می‌شود.
مقادیر معتبر
.I yes
یا
.IR no
هستند.
.TP 8
.I delete
برای حذف فایل منبع در ماشین مبدا پس از انتقال موفقیت‌آمیز فایل به ماشین مقصد استفاده می‌شود.
به طور پیش‌فرض، فایل‌های منبع حذف نمی‌شوند.
مقادیر معتبر
.I yes
یا
.IR no
هستند.
.TP 8
.I job\-name
این پارامتر توسط خود برنامه استفاده نمی‌شود، اما می‌تواند توسط ابزاری که فایل‌های کار را به صورت خودکار تولید می‌کند به کار رود.
برای نمونه، هنگام استفاده از گزینه
.I \-bbb
همراه با
.IR ncftpput ،
یک فایل کار در خروجی استاندارد تولید می‌شود که دارای پارامتر
.I job\-name
است تا بتوانید به راحتی فایل را با همان نام پیشنهادی به دایرکتوری صف کارها کپی کنید.
.TP 8
.I pre\-ftp\-command
.TP 8
.I post\-ftp\-command
این پارامترها متناظر با گزینه‌های
.IR "\-W" " و " "\-Y"
در
.I ncftpget
و
.I ncftpput
هستند.
توجه به این نکته ضروری است که این دستورات به دستورات پروتکل انتقال فایل RFC959 اشاره دارند و
.B نه
دستورات پوسته (shell) و نه دستوراتی که در محیط /usr/bin/ftp یا ncftp اجرا می‌شوند.
.TP 8
.I pre\-shell\-command
.TP 8
.I post\-shell\-command
این پارامترها قلاب‌هایی (hooks) فراهم می‌کنند تا بتوانید هنگام پردازش یک مورد توسط اسپولر، یک برنامه سفارشی را اجرا کنید.
مقادیر معتبر، مسیرهای اسکریپت‌ها یا برنامه‌های اجرایی هستند.
توجه داشته باشید که این مقدار نباید شامل آرگومان‌های خط فرمان باشد؛ اگر به آرگومان نیاز دارید، یک اسکریپت شل بسازید و برنامه خود را با آرگومان‌های خط فرمان مورد نیاز درون آن فراخوانی کنید.
.PP
به طور کلی،
.I post\-shell\-command
بسیار مفیدتر از
.I pre\-shell\-command
است؛ زیرا اگر نیاز به استفاده از این گزینه‌ها داشته باشید، احتمالاً مایلید کاری را پس از اتمام انتقال FTP انجام دهید تا قبل از آن.
به عنوان مثال، ممکن است بخواهید یک اسکریپت شل را اجرا کنید که با ارسال پیامی به مدیر سیستم اطلاع دهد بارگیری فایل ۳۷ گیگابایتی او به پایان رسیده است.
.PP
هنگامی که برنامه سفارشی شما اجرا می‌شود، محتوای فایل کار را در ورودی استاندارد (یعنی چند خط از جفت‌های کلید-مقدار
.IR variable = value )
و همچنین داده‌های اضافی که اسپولر ممکن است فراهم کند دریافت می‌کند؛ نظیر جفت کلید-مقدار
.I result
با توصیف متنی وضعیت اتمام کار.
.PP
در ادامه نمونه‌ای از یک اسکریپت Perl آورده شده است که نشان می‌دهد چگونه یک
.I post\-shell\-command
یک فایل گزارش به نام
/var/log/ncftp_spooler.log
را به‌روزرسانی می‌کند.
.RS 4
.sp
.nf
#!/usr/bin/perl -w

my ($line);
my (%params) = ();

while (defined($line = <STDIN>)) {
	$params{$1} = $2
		if ($line =~ /^([^=\\#\\s]+)=(.*)/);
}

if ((defined($params{"result"})) &&
  ($params{"result"} =~ /^Succeeded/))
{
	open(LOG, ">> /var/log/ncftp_spooler.log")
		or exit(1);
	print LOG "DOWNLOAD" if ($params{"op"} eq "get");
	print LOG "UPLOAD" if ($params{"op"} eq "put");
	print LOG " ", $params{"local-file"}, "\\n";
	close(LOG);
}
.fi
.RE
.\"-------
.SH "عیب‌یابی (DIAGNOSTICS)"
.\"-------
.PP
برای بررسی اینکه آیا فرایندی از
.I ncftpspooler
به طور فعال در حال انجام کارها است یا خیر، باید فایل گزارش بررسی شود.
فایل گزارش شامل مقادیر زیادی از اطلاعات مفید است؛ از جمله تمام گفتگوهای اتصال کنترلی FTP بین کلاینت و سرور FTP.
.\"-------
.SH "اشکالات (BUGS)"
.\"-------
.PP
گزینه
.I recursive
ممکن است قابل اعتماد نباشد، زیرا
.I ncftpspooler
به قابلیت‌هایی وابسته است که ممکن است در نرم‌افزار سرور راه دور وجود داشته یا نداشته باشند.
علاوه بر این، حتی در صورت وجود این قابلیت‌ها،
.I ncftpspooler
ممکن است نیاز به استفاده از روش‌های ابتکاری (heuristics) داشته باشد که نمی‌توان آن‌ها را ۱۰۰٪ دقیق دانست.
بنابراین بهتر است برای هر فایل در درخت دایرکتوری کارهای جداگانه ایجاد کنید، به جای اینکه از یک کار بازگشتی دایرکتوری تکی استفاده نمایید.
.PP
برای عملکرد صحیح قابلیت ازسرگیری بارگیری‌ها (resumption)، سرور راه دور باید از دستورات پایه‌ای
.I SIZE
و
.I MDTM
در FTP پشتیبانی کند.
اکثر نرم‌افزارهای مدرن سرور FTP این امکان را دارند، اما هنوز تعدادی از پیاده‌سازی‌های بسیار ساده
.I ftpd
وجود دارند که از این قابلیت‌ها پشتیبانی نمی‌کنند.
در این موارد،
.I ncftpspooler
هر بار کل فایل را از ابتدا دوباره بارگیری می‌کند تا زمانی که بارگیری موفقیت‌آمیز باشد.
.PP
این برنامه نیاز به بهبود دارد تا کارهایی را که هیچ شانسی برای اتمام موفقیت‌آمیز ندارند شناسایی کند.
هنوز مواردی وجود دارد که در آن‌ها کارها در صف قرار می‌گیرند و بارها و بارها تکرار می‌شوند تا زمانی که یک مدیر سیستم هوشیار به صورت دستی کارها را حذف کند.
.PP
فایل‌های اسپول ممکن است شامل نام‌های کاربری و گذرواژه‌های ذخیره‌شده به صورت متن خام (cleartext) باشند.
این فایل‌ها نباید برای هیچ کاربری به جز کاربری که برنامه را اجرا می‌کند قابل خواندن باشند!
.\"-------
.SH "نویسنده (AUTHOR)"
.\"-------
.PP
Mike Gleason, NcFTP Software (http://www.ncftp.com).
.\"-------
.SH "همچنین ببینید (SEE ALSO)"
.\"-------
.PP
.IR ncftpbatch (1)،
.IR ncftp (1)،
.IR ncftpput (1)،
.IR ncftpget (1)،
.IR uucp (1).