👨‍👩‍👧 🙆🏽 💰 एक Redmine प्लगइन लेखन 🧙🏻 🖐🏾 💾

शायद कई ने रेडमाइन परियोजना प्रबंधन प्रणाली के बारे में सुना है, और कुछ ने अपने काम में इसका इस्तेमाल भी किया होगा। रेडमाइन एक काफी लचीला क्रॉस-प्लेटफ़ॉर्म सिस्टम है जिसे प्रसिद्ध रूबी ऑन रेल्स फ्रेमवर्क में लिखा गया है। इस तरह की अधिकांश प्रणालियों की तरह, Redmine आपको थर्ड-पार्टी प्लग-इन के माध्यम से अपनी कार्यक्षमता का विस्तार करने की अनुमति देता है। फिलहाल, अलग-अलग स्वाद और रंगों के लिए इनमें से एक हजार से अधिक प्लगइन्स मौजूद हैं। मैं उनमें से एक के बारे में बात करना चाहता हूं और इसके उदाहरण का उपयोग करके एक रेडमाइन प्लगइन कैसे लिखना है।

रिपॉजिटरी प्लगइन - एक प्लगइन जो आपको प्रोजेक्ट रिपॉजिटरी (रिपॉजिटरी) से एक ज़िप संग्रह में फ़ाइलों और फ़ोल्डरों को डाउनलोड करने की अनुमति देता है। Redmine प्लगइन्स बनाने के लिए एक विजुअल गाइड प्रदान करता है।
तो, चलो प्लगइन लिखना शुरू करते हैं। सब कुछ है कि लिनक्स ओएस के साथ एक वेब सर्वर पर स्थापित चिंताओं को कम करने के लिए लिखा गया है।
सबसे पहले, हम उस निर्देशिका में जाते हैं जहाँ Redmine स्थापित है (उदाहरण के लिए, / var / www / redmine):

$ cd /var/www/redmine

पर्यावरण चर R नाखून_ENV सेट करें:

$ export RAILS_ENV="production"

अब हम अपने प्लगइन के लिए आवश्यक फाइलें उत्पन्न कर सकते हैं:

$ ruby script/generate redmine_plugin repository
create vendor/plugins/redmine_repository/app/controllers
create vendor/plugins/redmine_repository/app/helpers
create vendor/plugins/redmine_repository/app/models
create vendor/plugins/redmine_repository/app/views
create vendor/plugins/redmine_repository/db/migrate
create vendor/plugins/redmine_repository/lib/tasks
create vendor/plugins/redmine_repository/assets/images
create vendor/plugins/redmine_repository/assets/javascripts
create vendor/plugins/redmine_repository/assets/stylesheets
create vendor/plugins/redmine_repository/lang
create vendor/plugins/redmine_repository/README
create vendor/plugins/redmine_repository/init.rb
create vendor/plugins/redmine_repository/lang/en.yml

विक्रेता / प्लगइन्स / redmine_repository / init.rb फ़ाइल को निर्दिष्ट करें, निर्दिष्ट करें
इसमें प्लगिन, लेखक का नाम और न्यूनतम संस्करण का विवरण होता है, जिसके लिए प्लगइन लिखा गया है:

 require 'redmine' require 'dispatcher' Redmine::Plugin.register :redmine_repository do name 'Redmine Repository plugin' author 'Sanny' description 'This is a reposirory plugin for Redmine' version '0.0.2' requires_redmine :version_or_higher => '1.1.2' end

हमारे प्लगइन को आपको यह चुनने की अनुमति देना चाहिए कि रिपॉजिटरी से कौन सी फाइलें डाउनलोड करनी हैं। इसलिए, चेकबॉक्स को मौजूदा प्रकार के भंडारण में जोड़ा जाना चाहिए

क्योंकि यदि आपको मौजूदा प्रकार के संग्रहण को बदलने की आवश्यकता है, तो सबसे आसान तरीका यह है कि भंडारण की उपस्थिति के लिए जिम्मेदार फाइलों को हमारे प्लगइन की उपयुक्त निर्देशिका में कॉपी करें और फिर इन फ़ाइलों को संपादित करें:

$ cp app/views/repositories/_dir_lsit.rhtml vendor/plugins/redmine_repository/app/views/repositories
$ cp app/views/repositories/_dir_lsit_content.rhtml vendor/plugins/redmine_repository/app/views/repositories
$ cp app/views/repositories/show.rhtml vendor/plugins/redmine_repository/app/views/repositories

_Dir_lsit.rhtml फ़ाइल को रिपॉजिटरी फ़ाइल सिस्टम ट्री प्रदर्शित करने के लिए अस्वीकार कर दिया जाएगा। वहां हम डाउनलोड करने के लिए एक "डाउनलोड" बटन जोड़ देंगे:

 <% if authorize_for('repositories', 'entries_operation') %> <div style="float: right;"> <%= submit_tag(l(:Download), :name => "download_entries") %> </div> <% end %>

बटन को काम करने के लिए, सभी कोड को form_tag में लपेटें:

 <% form_tag({:action => "entries_operation"}, :method => :post, :id => "Entries") do %> ... <% if authorize_for('repositories', 'entries_operation') %> <div style="float: right;"> <%= submit_tag(l(:Download), :name => "download_entries") %> </div> <% end %> <p> </p> <% end %>

अब रिपॉजिटरी डिस्प्ले में प्रत्येक प्रविष्टि के लिए एक चेकबॉक्स जोड़ें। ऐसा करने के लिए, _dir_lsit_content.rhtml फ़ाइल में निम्न परिवर्तन करें:
के बजाय

 <% if entry.is_dir? %> <span class="expander" onclick="<%= remote_function :url => {:action => 'show', :id => @project, :path => to_path_param(ent_path), :rev => @rev, :depth => (depth + 1), :parent_id => tr_id}, :method => :get, :update => { :success => tr_id }, :position => :after, :success => "scmEntryLoaded('#{tr_id}')", :condition => "scmEntryClick('#{tr_id}')"%>"> </span> <% end %>

लिखने

 <% if entry.is_dir? %> <span class="expander" onclick="<%= remote_function :url => {:action => 'show', :id => @project, :path => to_path_param(entry.path), :rev => @rev, :depth => (depth + 1), :parent_id => tr_id, :p arent_val => entry.path}, :method => :get, :update => { :success => tr_id }, :position => :after, :success => "scmEntryLoaded('#{tr_id}')", :complete => "checkBranch('#{tr_id}', getParentNodeChecked('#{params[:parent_val]}'))", :condition => "scmEntryClick('#{tr_id}')"%>"> </span> <span><%= check_box_tag("folders[]", entry.path, false, :id => params[:parent_id], :onclick => "checkBranch('#{tr_id}', this.checked);" ) if authorize_for('repositories', 'entries_operation') %></span> <% else %> <span style="padding-left: 8px"> </span> <span><%= check_box_tag("files[]", entry.path, false, :id => params[:parent_id]) if authorize_for('repositories', 'entries_operation') %></span> <% end %>

दो जावास्क्रिप्ट कार्यों का उपयोग यहां किया जाता है:
getParentNodeChecked(parentVal) - इस ट्री नोड के जनक के चेकबॉक्स की स्थिति को निर्धारित करता है,
checkBranch(parentId, checked) - ट्री नोड के वंशजों के चेकबॉक्स को अभिभावक के रूप में राज्य में सेट करता है (मोटे तौर पर, यदि कोई निर्देशिका चुनी जाती है, तो इस निर्देशिका में सभी उपनिर्देशिकाएँ और फ़ाइलें चयनित हैं)।
उन्हें नई संपत्ति / javascripts / repository.js फ़ाइल में बनाएँ

 function getParentNodeChecked(parentVal) { var form = document.getElementById('Entries'); for (var i=0;i<form.elements.length;i++) { var e = form.elements[i]; if(e.type=='checkbox' && e.value == parentVal) return e.checked; } } function checkBranch(parentId, checked) { var allchecked = true; var has_check_tree = false; var form = document.getElementById('Entries'); for (var i=0;i<form.elements.length;i++) { var e = form.elements[i]; if(e.type=='checkbox') { if(e.id == parentId) { e.checked = !checked; e.click(); } allchecked = allchecked && e.checked; if(e.name == "check_tree") has_check_tree = true; } } if(has_check_tree) form.check_tree.checked = allchecked; }

हमारी नई रिपॉजिटरी मैपिंग (show.rhtml फ़ाइल में) से हमारे रिपॉजिटरी.जेएस को कनेक्ट करें:

 ... <% content_for :header_tags do %> <%= stylesheet_link_tag "scm" %> <%= javascript_include_tag "repository.js", :plugin => "redmine_repository" %> <% end %>

यह चयनित फ़ोल्डर और फ़ाइलों को संग्रहित करने के कार्य को जोड़ने के लिए बना हुआ है। कार्यान्वयन रूबी भाषा में किया जाएगा। इसके अतिरिक्त, ज़िप अभिलेखागार का समर्थन करने के लिए, आपको रूबीज़ पैकेज (रत्न स्थापित रूबीज़िप) स्थापित करना होगा।
आइए, रिपॉजिटरीज़िप क्लास बनाएं, जो सीधे आर्काइविंग में शामिल होगा (फाइल ऐप / हेल्पर्स / रिपॉजिटरी_ज़िप। आरबी):

 require 'zip/zip' require 'zip/zipfilesystem' class RepositoryZip attr_reader :file_count def initialize() @zip = Tempfile.new(["repository_zip",".zip"]) @zip_file = Zip::ZipOutputStream.new(@zip.path) @file_count = 0 end def finish @zip_file.close unless @zip_file.nil? @zip.path unless @zip.nil? end def close @zip_file.close unless @zip_file.nil? @zip.close unless @zip.nil? end def add_file(file, cat) @zip_file.put_next_entry(file) @zip_file.write(cat) @file_count += 1 end def add_folder(folder) @zip_file.put_next_entry(folder + "/") end end

अब हम Redmine में मौजूद रिपॉजिटरीकंट्रोलर क्लास को "पैच" करेंगे, इसमें कई तरीके जोड़कर (फ़ाइल lib / repositories_controller_patch.rb)। मैं इस "पैच" के तर्क पर ध्यान नहीं दूंगा, मैं सिर्फ कोड दे दूंगा:

 require 'tree' require_dependency 'application_controller' require_dependency 'repositories_controller' require_dependency 'repository_zip' module RepositoriesControllerPatch def self.included(base) # :nodoc: base.extend(ClassMethods) base.send(:include, InstanceMethods) base.class_eval do unloadable #  unloadable      end end module ClassMethods end module InstanceMethods def entries_operation selected_folders = params[:folders].nil? ? [] : params[:folders] selected_files = params[:files].nil? ? [] : params[:files] if selected_folders.empty? && selected_files.empty? flash[:warning] = l(:warning_no_entries_selected) redirect_to :action => "show", :id => @project, :path => @path return end # make a selected files and folders tree selected_tree = Tree::TreeNode.new(".", "root") selected_files.each do |file| folder = Pathname.new(file).dirname.to_s selected_tree_node = selected_tree if !folder.match(/^\.+$/) folder.split("/").each do if selected_tree_node[folder].nil? selected_tree_node = selected_tree_node.add(Tree::TreeNode.new(folder, "folder")) else selected_tree_node = selected_tree_node[folder] end end selected_tree_node << Tree::TreeNode.new(file, "file") else selected_tree << Tree::TreeNode.new(file, "file") end end selected_folders.each do |folder| selected_tree_node = selected_tree folder.split("/").each do if selected_tree_node[folder].nil? selected_tree_node = selected_tree_node.add(Tree::TreeNode.new(folder, "folder")) else selected_tree_node = selected_tree_node[folder] end end selected_tree_node << Tree::TreeNode.new(file, "file") else selected_tree << Tree::TreeNode.new(file, "file") end end selected_folders.each do |folder| selected_tree_node = selected_tree folder.split("/").each do if selected_tree_node[folder].nil? selected_tree_node = selected_tree_node.add(Tree::TreeNode.new(folder, "folder")) else selected_tree_node = selected_tree_node[folder] end end end begin if !params[:email_entries].blank? email_entries(selected_tree) else download_entries(selected_tree) end rescue => e flash[:warning] = l(:error_in_getting_files) + " (" + e.message + ")" redirect_to :action => "show", :id => @project end end def download_entries(selected_tree) zip = RepositoryZip.new zip_entries(zip, selected_tree) send_file(zip.finish, :filename => filename_for_content_disposition(@project.name + "-" + DateTime.now.strftime("%y%m%d%H%M%S") + ".zip"), :type => "application/zip", :disposition => "attachment") ensure zip.close unless zip.nil? end def zip_entries(zip, selected_tree) selected_tree.children.each do |node| if node.content == "file" zip.add_file(node.name, @repository.cat(node.name, @rev)) else zip.add_folder(node.name) if node.hasChildren? # add selected subfolders zip_entries(zip, node) else # add all subfolders with files entries = @repository.entries(node.name, @rev) entries.each do |entry| node << Tree::TreeNode.new(entry.path, entry.is_dir? ? "folder" : "file") end end zip_entries(zip, node) end end zip end end # of InstaceMethods end # of module RepositoriesController.send(:include, RepositoriesControllerPatch)

entries_operation विधि संग्रह के लिए फ़ाइलों और फ़ोल्डरों की सूची बनाने के लिए जिम्मेदार है।
डाउनलोड_ेंट्री विधि उपयोगकर्ता द्वारा संग्रह को डाउनलोड करने के लिए जिम्मेदार है।
चयनित फ़ाइलों और फ़ोल्डरों को संग्रहीत करने के लिए zip_entries विधि जिम्मेदार है।

बस इतना ही। यह केवल Redmine सिस्टम के उपयोगकर्ताओं और प्लगइन के स्थानीयकरण के लिए फाइल डाउनलोड करने के लिए अनुमतियाँ जोड़ने के लिए बनी हुई है। अनुमतियाँ जोड़ने के लिए init.rb फ़ाइल संपादित करें:

 require 'redmine' require 'dispatcher' require 'repositories_controller_patch' Redmine::Plugin.register :redmine_repository do name 'Redmine Repository plugin' author 'Sanny' description 'This is a reposirory plugin for Redmine' version '0.0.2' requires_redmine :version_or_higher => '1.1.2' end Redmine::AccessControl.map do |map| map.project_module :repository do |map| map.permission :operations, :repositories => [:entries_operation] end end

स्थानीयकरण फ़ाइलें कॉन्फ़िगरेशन / स्थान निर्देशिका में स्थित हैं। रूसी भाषा के लिए, ru.yml फ़ाइल बनाएँ:

 ru: Download: "Download" warning_no_entries_selected: "  " error_in_getting_files: "    " permission_operations: "    "

हम Redmine को पुनरारंभ करते हैं, सिस्टम के विभिन्न उपयोगकर्ताओं के लिए एक संग्रह में फ़ाइलों को डाउनलोड करने के लिए अनुमतियों को कॉन्फ़िगर करते हैं और इसका उपयोग करते हैं।

एक Redmine प्लगइन लेखन

More articles: