Сеть архивов Perl-модулей CPAN

Введение

Репозиторий программных модулей Perl

Комплексная сеть архивов Perl (Comprehensive Perl Archive Network, CPAN) — это хранилище более 250 000 программных модулей и сопутствующей документации для 39 000 дистрибутивов, написанных на языке программирования Perl более чем 12 000 разработчиков. CPAN может означать как саму архивную сеть, так и программу на Perl, которая служит интерфейсом к сети и автоматизированным установщиком программного обеспечения (в некоторой степени напоминающим менеджер пакетов). Большинство программ в CPAN распространяются под свободной и открытой лицензией.

История

CPAN был задуман в 1993 году и функционирует в сети с октября 1995 года. Он основан на модели CTAN и изначально создавался как платформа для объединения структуры разрозненных архивов Perl.

Роль

Как и многие языки программирования, Perl имеет механизмы для использования внешних библиотек кода, позволяющие одному файлу содержать общие подпрограммы, используемые несколькими программами. Perl называет их модулями. Модули Perl обычно устанавливаются в один из нескольких каталогов, пути к которым указываются интерпретатору Perl при его первой компиляции; в Unix-подобных операционных системах распространёнными путями являются /usr/lib/perl5, /usr/local/lib/perl5 и несколько их подкаталогов. Perl поставляется с небольшим набором базовых модулей. Некоторые из них выполняют задачи начальной настройки, такие как ExtUtils::MakeMaker, который используется для создания файлов Makefile для сборки и установки других расширений; другие, такие как List::Util, просто широко используются. Основная цель CPAN — помочь программистам находить модули и программы, не входящие в стандартный дистрибутив Perl. Его структура децентрализована. Авторы поддерживают и улучшают собственные модули. Разветвление и создание конкурирующих модулей для одной и той же задачи или цели — обычное явление. Существует сторонняя система отслеживания ошибок, которая автоматически настраивается для любого загруженного дистрибутива, но авторы могут выбрать другую систему отслеживания ошибок, например, GitHub. Аналогично, хотя GitHub является популярным местом для хранения исходного кода дистрибутивов, он может храниться в любом месте, предпочитаемом автором, или вообще не быть общедоступным. Разработчики могут предоставлять другим права на поддержку или перехват управления своими модулями, а администраторы могут предоставлять права желающим перехватить управление заброшенными модулями. Предыдущие версии обновлённых дистрибутивов сохраняются на CPAN до удаления загрузчиком, а вторичная зеркальная сеть под названием BackPAN сохраняет дистрибутивы, даже если они удалены из CPAN. Кроме того, полная история CPAN и всех его модулей доступна в виде проекта GitPAN, что позволяет легко просматривать полную историю каждого модуля и упрощает поддержку ответвлений. CPAN также используется для распространения новых версий Perl, а также связанных проектов, таких как Parrot и Raku.

Like many programming languages, Perl has mechanisms to use external libraries of code, making one file contain common routines used by several programs. Perl calls these modules. Perl modules are typically installed in one of several directories whose paths are placed in the Perl interpreter when it is first compiled; on Unix like operating systems, common paths include /usr/lib/perl5, /usr/local/lib/perl5, and several of their subdirectories. Perl comes with a small set of core modules. Some of these perform bootstrapping tasks, such as ExtUtils::MakeMaker, which is used to create Makefiles for building and installing other extension modules; others, like List::Util, are merely commonly used. CPAN's main purpose is to help programmers locate modules and programs not included in the Perl standard distribution. Its structure is decentralized. Authors maintain and improve their own modules. Forking, and creating competing modules for the same task or purpose, is common. There is a third party bug tracking system that is automatically set up for any uploaded distribution, but authors may opt to use a different bug tracking system such as GitHub. Similarly, though GitHub is a popular location to store the source for distributions, it may be stored anywhere the author prefers, or may not be publicly accessible at all. Maintainers may grant permissions to others to maintain or take over their modules, and permissions may be granted by admins for those wishing to take over abandoned modules. Previous versions of updated distributions are retained on CPAN until deleted by the uploader, and a secondary mirror network called BackPAN retains distributions even if they are deleted from CPAN. Also, the complete history of the CPAN and all its modules is available as the GitPAN project, allowing to easily see the complete history for all the modules and for easy maintenance of forks. CPAN is also used to distribute new versions of Perl, as well as related projects, such as Parrot and Raku.

Структура

Файлы в CPAN называются дистрибутивами. Дистрибутив может состоять из одного или нескольких модулей, файлов документации или программ, упакованных в общий формат архивации, такой как gzipped tar-архив или ZIP-файл. Дистрибутивы часто содержат скрипты установки (обычно называемые Makefile.PL или Build.PL) и тестовые скрипты, которые можно запустить для проверки правильности работы содержимого дистрибутива. Новые дистрибутивы загружаются на сервер загрузки авторов Perl, или PAUSE (см. раздел «Загрузка дистрибутивов с помощью PAUSE»). В 2003 году дистрибутивы начали включать файлы метаданных, называемые META.yml, которые указывают имя дистрибутива, версию, зависимости и другую полезную информацию; однако не все дистрибутивы содержат метаданные. Если метаданные отсутствуют в дистрибутиве, программное обеспечение PAUSE попытается проанализировать код в дистрибутиве, чтобы найти ту же информацию; это не всегда надежно. В 2010 году была создана версия 2 этой спецификации для использования через новый файл под названием META.json, а файл в формате YAML часто также включается для обратной совместимости. Учитывая тысячи дистрибутивов, CPAN должен быть структурирован для удобства использования. Авторы часто размещают свои модули в естественной иерархии имен модулей Perl (например, Apache::DBI или Lingua::EN::Inflect) в соответствии с назначением или областью применения, хотя это не является обязательным требованием. Дистрибутивы модулей CPAN обычно имеют названия в формате CGI Application 3.1 (где «::», используемые в имени модуля, заменены дефисом, а номер версии добавлен к имени), но это лишь соглашение; многие известные дистрибутивы нарушают это соглашение, особенно те, которые содержат несколько модулей. Соображения безопасности не позволяют заменить дистрибутив файлом с тем же именем, поэтому практически все имена дистрибутивов включают номер версии.

Компоненты

Распределительная инфраструктура CPAN состоит из её всемирной сети, включающей более 250 зеркал в более чем 60 странах. Каждое полное зеркало содержит около 31 гигабайта данных. Большинство зеркал обновляются ежечасно, ежедневно или раз в два дня с основного сайта CPAN. Некоторые сайты являются крупными FTP-серверами, зеркалирующими множество других программ, а другие – просто серверами, принадлежащими компаниям, активно использующим Perl. На каждом континенте, кроме Антарктиды, есть как минимум два зеркала. Для помощи программистам Perl в поиске по CPAN было разработано несколько поисковых систем. Официальный поисковик включает в себя текстовый поиск, просматриваемый индекс модулей и извлеченные копии всех дистрибутивов, находящихся в CPAN. 16 мая 2018 года Perl Foundation объявила о закрытии search.cpan.org 29 июня 2018 года (после 19 лет работы) из-за устаревшей кодовой базы и сложности обслуживания. Пользователи будут перенаправлены на стороннюю альтернативу MetaCPAN. CPAN Testers – это группа добровольцев, которые загружают и тестируют дистрибутивы сразу после их загрузки в CPAN. Это позволяет авторам тестировать свои модули на множестве платформ и в различных средах, к которым они в противном случае не имели бы доступа, что способствует переносимости и повышению качества. Smoke testers отправляют отчеты, которые затем собираются и используются для различных веб-сайтов, включая основной сайт отчетов, статистику и информацию о зависимостях. Авторы могут загружать новые дистрибутивы в CPAN через Perl Authors Upload Server (PAUSE). Для этого им необходимо запросить учетную запись PAUSE. После регистрации они могут использовать веб-интерфейс на pause.perl.org или FTP-интерфейс для загрузки файлов в свой каталог и их удаления. Модули будут индексироваться как канонические только в том случае, если имя модуля ещё не использовалось (предоставляя приоритет первому загрузившему), или если у загружающего есть разрешение на использование этого имени, и если версия модуля выше, чем любая существующая запись. Это можно указать через веб-интерфейс PAUSE.

The distribution infrastructure of CPAN consists of its worldwide network of more than 250 mirrors in more than 60 countries. Each full mirror hosts around 31 gigabytes of data. Most mirrors update themselves hourly, daily or bidaily from the CPAN master site. Some sites are major FTP servers which mirror lots of other software, but others are simply servers owned by companies that use Perl heavily. There are at least two mirrors on every continent except Antarctica. Several search engines have been written to help Perl programmers sort through the CPAN. The official includes textual search, a browsable index of modules, and extracted copies of all distributions currently on the CPAN. On 16 May 2018, the Perl Foundation announced that search. cpan. org would be shut down on 29 June 2018 (after 19 years of operation), due to its aging codebase and maintenance burden. Users will be transitioned and redirected to the third party alternative MetaCPAN. CPAN Testers are a group of volunteers, who will download and test distributions as they are uploaded to CPAN. This enables the authors to have their modules tested on many platforms and environments that they would otherwise not have access to, thus helping to promote portability, as well as a degree of quality. Smoke testers send reports, which are then collated and used for a variety of presentation websites, including the main reports site, statistics and dependencies. Authors can upload new distributions to the CPAN through the Perl Authors Upload Server (PAUSE). To do so, they must request a PAUSE account. Once registered, they may use a web interface at pause. perl. org, or an FTP interface to upload files to their directory and delete them. Modules in the upload will only be indexed as canonical if the module name has not been used before (granting first come permission to the uploader), or if the uploader has permission for that name, and if the module is a higher version than any existing entry. This can be specified through PAUSE's web interface.

CPAN.pm, CPANPLUS и cpanminus

Существует также модуль Perl core с именем CPAN; он обычно отличается от самого репозитория использованием имени CPAN.pm. CPAN.pm – это в основном интерактивная оболочка, которая может использоваться для поиска, загрузки и установки дистрибутивов. В ядре Perl также предусмотрена интерактивная оболочка, которая является обычным способом запуска CPAN.pm. После короткого процесса настройки и выбора зеркала, она использует инструменты, доступные на компьютере пользователя, для автоматической загрузки, распаковки, компиляции, тестирования и установки модулей. Она также способна к самообновлению. Попытка заменить CPAN.pm на более чистое и современное решение привела к созданию набора модулей CPANPLUS (или CPAN++). CPANPLUS разделяет операции загрузки, компиляции и установки модулей от интерактивной оболочки, используемой для ввода команд. Он также поддерживает несколько расширенных функций, таких как проверка криптографических подписей и отчетность о результатах тестирования. Наконец, CPANPLUS может удалять дистрибутивы. CPANPLUS был добавлен в ядро Perl в версии 5.10.0 и удален из него в версии 5.20.0. Более компактная и современная альтернатива этим установщикам CPAN была разработана под названием cpanminus. cpanminus был разработан для минимального потребления памяти, что часто необходимо в средах с ограниченными ресурсами, и для использования в качестве автономного скрипта, способного даже к самоустановке, требуя лишь наличие ожидаемого набора основных модулей Perl. Он также доступен в CPAN как модуль App::cpanminus, который устанавливает скрипт. Он не поддерживает и не полагается на постоянную конфигурацию, а настраивается только через переменные окружения и параметры командной строки. cpanminus не имеет компонента интерактивной оболочки. Он распознает формат cpanfile для указания зависимостей, что полезно в ad hoc Perl-проектах, которые могут быть не предназначены для установки через CPAN. cpanminus также обладает возможностью удаления дистрибутивов. Каждый из этих модулей может проверять зависимости дистрибутива и рекурсивно устанавливать любые необходимые зависимости, либо автоматически, либо с подтверждением пользователя. Все они поддерживают протоколы FTP и HTTP и могут работать через брандмауэры и прокси-серверы.

There is also a Perl core module named CPAN; it is usually differentiated from the repository itself by using the name CPAN. pm. CPAN. pm is mainly an interactive shell which can be used to search for, download, and install distributions. An interactive shell called is also provided in the Perl core, and is the usual way of running CPAN. pm. After a short configuration process and mirror selection, it uses tools available on the user's computer to automatically download, unpack, compile, test, and install modules. It is also capable of updating itself. An effort to replace CPAN. pm with something cleaner and more modern resulted in the CPANPLUS (or CPAN++) set of modules. CPANPLUS separates the back end work of downloading, compiling, and installing modules from the interactive shell used to issue commands. It also supports several advanced features, such as cryptographic signature checking and test result reporting. Finally, CPANPLUS can uninstall a distribution. CPANPLUS was added to the Perl core in version 5.10.0, and removed from it in version 5.20.0. A smaller, leaner modern alternative to these CPAN installers was developed called cpanminus. cpanminus was designed to have a much smaller memory footprint as often required in limited memory environments, and to be usable as a standalone script such that it can even install itself, requiring only the expected set of core Perl modules to be available. It is also available from CPAN as the module App::cpanminus, which installs the script. It does not maintain or rely on a persistent configuration, but is configured only by the environment and command line options. cpanminus does not have an interactive shell component. It recognizes the cpanfile format for specifying prerequisites, useful in ad hoc Perl projects that may not be designed for CPAN installation. cpanminus also has the ability to uninstall distributions. Each of these modules can check a distribution's dependencies and recursively install any prerequisites, either automatically or with individual user approval. Each support FTP and HTTP and can work through firewalls and proxies.

Влияние

Опытные программисты часто отмечают, что половина мощности Perl заключена в CPAN. Его называют главным преимуществом Perl. Он примерно эквивалентен Composer для PHP; PyPI (Python Package Index) – репозиторий для Python; RubyGems для Ruby; CRAN для R; npm для Node.js; LuaRocks для Lua; Maven для Java; и Hackage для Haskell. Использование CPAN структурированных пространств имен, системы тестирования и чёткого стиля документации делает его уникальным. Учитывая его важность для сообщества разработчиков Perl, CPAN как формирует, так и формируется культурой Perl. Его "самопровозглашенный главный библиотекарь", Яркко Хиетаниеми, часто участвует в шутках в День дураков; 1 апреля 2002 года сайт был временно переименован в CJAN, где "J" обозначало "Java". В 2003 году доменное имя www.cpan.org было перенаправлено на Matt's Script Archive, сайт, печально известный в сообществе Perl из-за плохо написанного кода. Некоторые дистрибутивы в CPAN распространяются в виде шуток. Иерархия Acme:: зарезервирована для шуточных модулей; например, Acme::Don't добавляет функцию don't, которая не выполняет переданный ей код (в дополнение к встроенной функции do, которая выполняет). Даже за пределами иерархии Acme:: некоторые модули пишутся в основном ради развлечения; одним из примеров является Lingua::Romana::Perligata, который позволяет писать программы на Perl на подмножестве латинского языка. В 2005 году группа разработчиков Perl, также интересующихся JavaScript, объединилась для создания JSAN – сети архивов JavaScript. JSAN является почти прямой пересадкой инфраструктуры CPAN для использования с языком JavaScript, который на протяжении большей части своего существования не имел единого "сообщества". В 2008 году, после случайной встречи с администратором CPAN Адамом Кеннеди на конференции разработчиков Open Source, разработчик ядра Linux Расти Расселл создал CCAN – Comprehensive C Archive Network. CCAN является прямой пересадкой архитектуры CPAN для использования с языком C. CRAN, Comprehensive R Archive Network, представляет собой набор зеркал, размещающих дистрибутивы языка программирования R, документацию и дополнительные пакеты.

Experienced Perl programmers often comment that half of Perl's power is in the CPAN. It has been called Perl's killer app. It is roughly equivalent to Composer for PHP; the PyPI (Python Package Index) repository for Python; RubyGems for Ruby; CRAN for R; npm for Node. js; LuaRocks for Lua; Maven for Java; and Hackage for Haskell. CPAN's use of arbitrated name spaces, a testing regime and a well defined documentation style makes it unique. Given its importance to the Perl developer community, the CPAN both shapes and is shaped by Perl's culture. Its "self appointed master librarian", Jarkko Hietaniemi, often takes part in the April Fools' Day jokes; on 1 April 2002 the site was temporarily named to CJAN, where the "J" stood for "Java". In 2003, the www. cpan. org domain name was redirected to Matt's Script Archive, a site infamous in the Perl community for having badly written code. Some of the distributions on the CPAN are distributed as jokes. The Acme:: hierarchy is reserved for joke modules; for instance, Acme::Don't adds a don't function that doesn't run the code given to it (to complement the do built in, which does). Even outside the Acme:: hierarchy, some modules are still written largely for amusement; one example is Lingua::Romana::Perligata, which can be used to write Perl programs in a subset of Latin. In 2005, a group of Perl developers who also had an interest in JavaScript got together to create JSAN, the JavaScript Archive Network. The JSAN is a near direct port of the CPAN infrastructure for use with the JavaScript language, which for most of its lifespan did not have a cohesive "community". In 2008, after a chance meeting with CPAN admin Adam Kennedy at the Open Source Developers Conference, Linux kernel developer Rusty Russell created the CCAN, the Comprehensive C Archive Network. The CCAN is a direct port of the CPAN architecture for use with the C language. CRAN, the Comprehensive R Archive Network, is a set of mirrors hosting the R programming language distribution(s), documentation, and contributed extensions.