117 |
118 |
119 |
--------------------------------------------------------------------------------
/filechooser/src/main/res/drawable/json.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
11 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
10 |
12 |
14 |
16 |
18 |
20 |
22 |
24 |
26 |
28 |
30 |
32 |
34 |
36 |
38 |
40 |
42 |
44 |
46 |
48 |
50 |
52 |
54 |
56 |
58 |
60 |
62 |
64 |
66 |
68 |
70 |
72 |
74 |
75 |
--------------------------------------------------------------------------------
/filechooser/src/main/res/layout/file_item.xml:
--------------------------------------------------------------------------------
1 |
2 |
9 |
10 |
15 |
16 |
20 |
21 |
27 |
28 |
38 |
39 |
49 |
50 |
51 |
57 |
58 |
66 |
67 |
71 |
72 |
80 |
81 |
90 |
91 |
98 |
99 |
100 |
101 |
106 |
107 |
113 |
114 |
115 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [](https://jitpack.io/#iammohdzaki/KnotFileChooser-Android)
2 | []( https://android-arsenal.com/details/1/8056 )
3 |
4 | # KnotFileChooser-Android
5 |
6 |
7 |
8 | To get a Git project into your build:
9 |
10 | Step 1. Add the JitPack repository to your build file
11 | Add it in your root build.gradle at the end of repositories:
12 | ```
13 | allprojects {
14 | repositories {
15 | ...
16 | maven { url 'https://jitpack.io' }
17 | }
18 | }
19 | ```
20 | Step 2. Add the dependency
21 | ```
22 | dependencies {
23 | implementation 'com.github.iammohdzaki:KnotFileChooser-Android:$latest_version'
24 | }
25 | ```
26 | How To Use
27 | ```
28 | KnotFileChooser(this,
29 | allowBrowsing = true, // Allow User Browsing
30 | allowCreateFolder = true, // Allow User to create Folder
31 | allowMultipleFiles = false, // Allow User to Select Multiple Files
32 | allowSelectFolder = false, // Allow User to Select Folder
33 | minSelectedFiles = 0, // Allow User to Selec Minimum Files Selected
34 | maxSelectedFiles = 0, // Allow User to Selec Minimum Files Selected
35 | showFiles = true, // Show Files or Show Folder Only
36 | showFoldersFirst = true, // Show Folders First or Only Files
37 | showFolders = true, //Show Folders
38 | showHiddenFiles = false, // Show System Hidden Files
39 | initialFolder = Environment.getExternalStorageDirectory(), //Initial Folder
40 | restoreFolder = false, //Restore Folder After Adding
41 | cancelable = true) //Dismiss Dialog On Cancel (Optional)
42 | .title("Select a File") // Title of Dialog
43 | .sorter(Sorter.ByNewestModification) // Sort Data (Optional)
44 | fileType = FileType.ALL //Select Which Files you want to show (By Default : ALL)
45 | .onSelectedFilesListener { // Callback Returns Selected File Object (Optional)
46 | Toast.makeText(this, it.toString(), Toast.LENGTH_SHORT).show()
47 | }
48 | .onSelectedFileUriListener { // Callback Returns Uri of File (Optional)
49 |
50 | }
51 | .show()
52 | ```
53 | File Types
54 | ```
55 | enum class FileType {
56 | ALL,
57 | DOCUMENTS,
58 | AUDIO,
59 | VIDEO,
60 | IMAGE,
61 | DATABASE,
62 | CODE,
63 | APK
64 | }
65 | ```
66 | Additional Feature
67 | ```
68 | //If you want user to select a path to save a file then
69 | minSelectedFiles = 0, // Allow User to Selec Minimum Files Selected
70 | maxSelectedFiles = 0, // Allow User to Selec Minimum Files Selected
71 | //This will automatically return the path
72 | ```
73 | Customise
74 | ```
75 |
76 |
99 | ```
100 | For Android 10 - Add this in your Manifest
101 | ```
102 | android:requestLegacyExternalStorage="true"
103 | ```
104 | Permissions
105 | ```
106 |
107 |
108 | ```
109 | License
110 | ```
111 | The MIT License (MIT)
112 |
113 | Copyright (c) 2019 Tiago Melo & Mohammad Zaki
114 |
115 | Permission is hereby granted, free of charge, to any person obtaining a copy
116 | of this software and associated documentation files (the "Software"), to deal
117 | in the Software without restriction, including without limitation the rights
118 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
119 | copies of the Software, and to permit persons to whom the Software is
120 | furnished to do so, subject to the following conditions:
121 |
122 | The above copyright notice and this permission notice shall be included in all
123 | copies or substantial portions of the Software.
124 |
125 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
126 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
127 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
128 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
129 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
130 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
131 | SOFTWARE.
132 | ```
133 |
--------------------------------------------------------------------------------
/filechooser/src/main/res/layout/dialog_file_chooser.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
9 |
21 |
22 |
32 |
33 |
39 |
40 |
46 |
47 |
56 |
57 |
64 |
65 |
66 |
72 |
73 |
81 |
82 |
90 |
91 |
92 |
98 |
99 |
107 |
108 |
116 |
117 |
118 |
129 |
130 |
136 |
137 |
146 |
147 |
154 |
155 |
156 |
162 |
163 |
172 |
173 |
180 |
181 |
182 |
183 |
192 |
193 |
203 |
204 |
205 |
211 |
212 |
222 |
223 |
230 |
231 |
232 |
237 |
238 |
245 |
246 |
247 |
259 |
--------------------------------------------------------------------------------
/filechooser/src/main/java/com/zaphlabs/filechooser/KnotFileChooser.kt:
--------------------------------------------------------------------------------
1 | package com.zaphlabs.filechooser
2 |
3 | import android.Manifest
4 | import android.content.Context
5 | import android.content.pm.PackageManager
6 | import android.net.Uri
7 | import android.os.Environment
8 | import androidx.annotation.StringRes
9 | import com.google.android.material.floatingactionbutton.FloatingActionButton
10 | import androidx.swiperefreshlayout.widget.SwipeRefreshLayout
11 | import androidx.recyclerview.widget.LinearLayoutManager
12 | import androidx.recyclerview.widget.RecyclerView
13 | import android.text.*
14 | import android.util.TypedValue
15 | import android.view.View
16 | import android.widget.*
17 | import androidx.core.content.ContextCompat
18 | import br.tiagohm.breadcrumbview.BreadCrumbItem
19 | import br.tiagohm.breadcrumbview.BreadCrumbView
20 | import br.tiagohm.easyadapter.EasyAdapter
21 | import com.afollestad.materialdialogs.MaterialDialog
22 | import com.zaphlabs.filechooser.filters.Filter
23 | import com.zaphlabs.filechooser.preference.ChooserSharedPreference
24 | import com.zaphlabs.filechooser.utils.*
25 | import java.io.File
26 | import java.io.FileFilter
27 | import java.lang.StringBuilder
28 | import java.util.*
29 | import java.util.concurrent.ConcurrentHashMap
30 |
31 | open class KnotFileChooser(
32 | val context: Context,
33 | val allowMultipleFiles: Boolean = false,
34 | val allowCreateFolder: Boolean = false,
35 | var initialFolder: File = Environment.getDataDirectory(),
36 | val allowSelectFolder: Boolean = false,
37 | val minSelectedFiles: Int = 0,
38 | val maxSelectedFiles: Int = Int.MAX_VALUE,
39 | val showHiddenFiles: Boolean = false,
40 | val showFoldersFirst: Boolean = true,
41 | val showFiles: Boolean = true,
42 | val showFolders: Boolean = true,
43 | val allowBrowsing: Boolean = true,
44 | val restoreFolder: Boolean = true,
45 | val cancelable: Boolean = true,
46 | val fileType: FileType = FileType.ALL
47 | ) {
48 |
49 | //Constants.
50 | private val typedValue = TypedValue()
51 | private val theme = context.theme
52 | private val archivesListAdapter = EasyAdapter()
53 | private val pathPack = LinkedList()
54 | private val seletionStatus = ConcurrentHashMap()
55 | private val filters = ArrayList()
56 | private val chooserTextWatcher = ChooserTextWatcher()
57 | private val chooserFileFilter = ChooserFileFilter()
58 | private val backgroundColor: Int by lazy {
59 | theme.resolveAttribute(R.attr.kfc_theme_background, typedValue, true)
60 | typedValue.data
61 | }
62 | private val forgroundColor: Int by lazy {
63 | theme.resolveAttribute(R.attr.kfc_theme_foreground, typedValue, true)
64 | typedValue.data
65 | }
66 | private val titleTheme: Int by lazy {
67 | theme.resolveAttribute(R.attr.kfc_theme_title, typedValue, true)
68 | typedValue.data
69 | }
70 | private val cancelTheme: Int by lazy {
71 | theme.resolveAttribute(R.attr.kfc_theme_cancel_button, typedValue, true)
72 | typedValue.data
73 | }
74 | private val okTheme: Int by lazy {
75 | theme.resolveAttribute(R.attr.kfc_theme_ok_button, typedValue, true)
76 | typedValue.data
77 | }
78 |
79 | //Variables.
80 | private var title: CharSequence? = ""
81 | private val archivesList: MutableSet =
82 | Collections.newSetFromMap(ConcurrentHashMap())
83 | private var cbSelectItem: CheckBox? = null
84 | private var selectedFile: File? = null
85 | private lateinit var file: File
86 | private var sort: Sorter = Sorter.ByNameInAscendingOrder
87 | private lateinit var dialog: DialogBuilder
88 | private var searchText = ""
89 | private var currentArchives: List = Collections.emptyList()
90 | private var selectedArchiveTotalSize = 0L
91 | private var onSelectedFilesListener: (files: List) -> Unit = {}
92 | private var onSelectedFileUriListener: (files: List) -> Unit = {}
93 |
94 | init {
95 | //Default Home Folder.
96 | defaultHomeFolder(
97 | ChooserSharedPreference.getPreviouslySelectedDirectory(
98 | context,
99 | restoreFolder,
100 | initialFolder
101 | )
102 | )
103 | }
104 |
105 | /**
106 | * Sets the title of the window.
107 | */
108 | fun title(title: CharSequence?): KnotFileChooser {
109 | this.title = title
110 | return this
111 | }
112 |
113 | /**
114 | * Sets the title of the window.
115 | */
116 | fun title(@StringRes resId: Int): KnotFileChooser {
117 | return title(context.getText(resId))
118 | }
119 |
120 | /**
121 | * Defines the sorting method for listing files and folders.
122 | */
123 | fun sorter(sorter: Sorter): KnotFileChooser {
124 | sort = sorter
125 | return this
126 | }
127 |
128 | fun onSelectedFilesListener(listener: (files: List) -> Unit): KnotFileChooser {
129 | onSelectedFilesListener = listener
130 | return this
131 | }
132 |
133 | fun onSelectedFileUriListener(listener: (files: List) -> Unit): KnotFileChooser {
134 | onSelectedFileUriListener = listener
135 | return this
136 | }
137 |
138 | private fun defaultHomeFolder(folder: File): KnotFileChooser {
139 | initialFolder = folder
140 | file = folder
141 | //Clear the Path
142 | pathPack.clear()
143 | //Insert the Path.
144 | pathPack.addFirst(file)
145 | //Selected File.
146 | seletionStatus[file] = false
147 | return this
148 | }
149 |
150 | private fun displayBreadCrumbView(file: File) {
151 | var mfile = file
152 | //Clean.
153 | dialog.mDirectoryPath.itens.clear()
154 | //Checks if it is not a folder.
155 | if (!mfile.isFolder) {
156 | mfile = mfile.parentFile
157 | }
158 | //Gets the parent folder.
159 | val parent = mfile.parentFile
160 | //It has no parent folder.
161 | if (parent == null) {
162 | val item = RootFileBreadCrumbItem(mfile)
163 | dialog.mDirectoryPath.addItem(item)
164 | }
165 | //Has parent folder.
166 | else {
167 | displayBreadCrumbView(parent)
168 | val item = FileBreadCrumbItem(mfile)
169 | dialog.mDirectoryPath.addItem(item)
170 | }
171 | }
172 |
173 | private fun selectFile(buttonView: CompoundButton?, file: File, selected: Boolean) {
174 | //Checkbox selection.
175 | if (selected) {
176 | //It is not multi-selectable and has a file selected.
177 | if (!allowMultipleFiles && cbSelectItem != null) {
178 | val cb = cbSelectItem!!
179 | cbSelectItem = null
180 | //Two files that are in the same folder.
181 | if (buttonView !== cb && file.parent == selectedFile?.parent) {
182 | //Deselect what is selected.
183 | cb.isChecked = false
184 | } else {
185 | //Remove what is selected.
186 | archivesList.remove(selectedFile)
187 | selectedFile = null
188 | }
189 | }
190 | //Adds the file.
191 | if (!archivesList.contains(file)) {
192 | selectedArchiveTotalSize += if (file.isFolder) 0 else file.length()
193 | }
194 | archivesList.add(file)
195 | } else {
196 | //Remove the file.
197 | if (archivesList.contains(file)) {
198 | selectedArchiveTotalSize -= if (file.isFolder) 0 else file.length()
199 | }
200 | archivesList.remove(file)
201 | selectedFile = null
202 | }
203 | //Marks the file that has been selected.
204 | cbSelectItem = buttonView as CheckBox?
205 | selectedFile = file
206 | //Updates the number of folders selected by plurality.
207 | dialog.displayQuantityOfSelectedItems(selectedArchiveTotalSize)
208 | }
209 |
210 | /**
211 | * Go to a specific folder.
212 | */
213 | fun goTo(file: File) {
214 | //Do not allow browsing.
215 | if (!allowBrowsing) {
216 | //nothing
217 | }
218 | //Browse only if it is a folder.
219 | else if (file.isFolder) {
220 | this.file = file
221 | pathPack.addFirst(this.file)
222 | //Browse only You have not yet browsed this folder. Select all is disabled if it is a folder.
223 | if (allowMultipleFiles && !seletionStatus.containsKey(file)) {
224 | seletionStatus[file] = false
225 | }
226 | loadCurrentFolder()
227 | //Sets the state of the select all button.
228 | dialog.mSelectAll.isChecked = allowMultipleFiles && seletionStatus[file]!!
229 | }
230 | }
231 |
232 | /**
233 | * go to home folder.
234 | */
235 | fun goToStart() {
236 | goTo(initialFolder)
237 | }
238 |
239 | private fun backTo(file: File): Boolean {
240 | //You can browse and it is a folder.
241 | return if (allowBrowsing && file.isFolder) {
242 | this.file = file
243 | loadCurrentFolder()
244 | //Sets the state of the select all button.
245 | dialog.mSelectAll.isChecked = allowMultipleFiles && seletionStatus[file] ?: false
246 | true
247 | } else {
248 | false
249 | }
250 | }
251 |
252 | /**
253 | Go to previous folder.
254 | */
255 | fun back(): Boolean {
256 | //If you can browse and there is a folder to browse.
257 | return if (allowBrowsing && pathPack.size > 1) {
258 | //Remove current folder from stack.
259 | pathPack.removeFirst()
260 | //Return to previous folder.
261 | backTo(pathPack.first)
262 | } else {
263 | false
264 | }
265 | }
266 |
267 | private fun compareFile(a: File, b: File): Int {
268 | //Sort by folders first.
269 | return if (showFoldersFirst) {
270 | when {
271 | a.isDirectory == b.isDirectory -> sort.compare(a, b)
272 | a.isDirectory -> -1
273 | else -> 1
274 | }
275 | } else {
276 | when {
277 | a.isFile == b.isFile -> sort.compare(a, b)
278 | a.isFile -> -1
279 | else -> 1
280 | }
281 | }
282 | }
283 |
284 | private fun scanFiles(file: File): List {
285 | //Get file list.
286 | val fileList = file.listFiles(chooserFileFilter)?.toMutableList() ?: Collections.emptyList()
287 | //Sets the number of items displayed..
288 | dialog.mItemQuantity.text = fileList.size.toString()
289 | //Order by.
290 | fileList.sortWith(Comparator { a, b -> compareFile(a, b) })
291 | return fileList
292 | }
293 |
294 | private fun displayRecyclerView(file: File) {
295 | currentArchives = scanFiles(file)
296 | archivesListAdapter.setData(currentArchives)
297 | }
298 |
299 | private fun loadCurrentFolder() {
300 | displayBreadCrumbView(file)
301 | displayRecyclerView(file)
302 | dialog.mTotalSize.text = file.sizeAsString
303 | }
304 |
305 | /**
306 | * Exit a dialog.
307 | */
308 | fun show() {
309 | //Check If Write permission is granted
310 | if (ContextCompat.checkSelfPermission(context,
311 | Manifest.permission.READ_EXTERNAL_STORAGE) != PackageManager.PERMISSION_GRANTED){
312 | Toast.makeText(context, "Please Grant Read Permission", Toast.LENGTH_SHORT).show()
313 | return
314 | }
315 | DialogBuilder()
316 | dialog.show()
317 | }
318 |
319 | private inner class DialogBuilder : MaterialDialog.Builder(context) {
320 |
321 | //Views on the Dialog.
322 | val mTitle: TextView by lazy { customView.findViewById(R.id.tvTitle) }
323 | val mDirectoryPath: BreadCrumbView by lazy {
324 | customView.findViewById>(
325 | R.id.directoryPath
326 | )
327 | }
328 | val mListFileFolders: RecyclerView by lazy { customView.findViewById(R.id.rvArchivesList) }
329 | val mTotalSize: TextView by lazy { customView.findViewById(R.id.totalSize) }
330 | val mItemQuantity: TextView by lazy { customView.findViewById(R.id.tvItemQuantity) }
331 | val mBack: ImageView by lazy { customView.findViewById(R.id.ivBack) }
332 | val mHomeDirectory: ImageView by lazy { customView.findViewById(R.id.ivHomeDirectory) }
333 | val mQuantityItemsSelected: TextView by lazy { customView.findViewById(R.id.tvTotalItemsSelected) }
334 | val mSearch: ImageView by lazy { customView.findViewById(R.id.ivSearch) }
335 | val mSearchField: EditText by lazy { customView.findViewById(R.id.etSearch) }
336 | val mSearchView: View by lazy { customView.findViewById(R.id.flSearchBox) }
337 | val mSwipeRefreshLayout: SwipeRefreshLayout by lazy {
338 | customView.findViewById(
339 | R.id.swipeRefreshLayout
340 | )
341 | }
342 | val mSelectAll: CheckBox by lazy { customView.findViewById(R.id.cbSelectAll) }
343 | val mCreateFolder: FloatingActionButton by lazy {
344 | customView.findViewById(
345 | R.id.fbAddFolder
346 | )
347 | }
348 |
349 | init {
350 | dialog = this
351 | customView(R.layout.dialog_file_chooser, false)
352 | if (this@KnotFileChooser.title.isNullOrEmpty()) mTitle.visibility =
353 | View.GONE else mTitle.text =
354 | this@KnotFileChooser.title
355 | positiveText(android.R.string.ok)
356 | negativeText(android.R.string.cancel)
357 | backgroundColor(this@KnotFileChooser.backgroundColor)
358 | positiveColor(forgroundColor)
359 | negativeColor(forgroundColor)
360 | mSwipeRefreshLayout.setColorSchemeColors(forgroundColor)
361 | cancelable(cancelable)
362 | canceledOnTouchOutside(false)
363 | autoDismiss(false)
364 | //Configure Recycler View
365 | mListFileFolders.layoutManager = LinearLayoutManager(context)
366 | archivesListAdapter.map(R.layout.file_item) { file, injector ->
367 | //Check If the File Type is Matched
368 | if (file.isFile) {
369 | if (!file.extension.checkFileType(fileType)) {
370 | return@map
371 | }
372 | }
373 | //Set File Icon.
374 | injector.image(
375 | R.id.fileIcon,
376 | if (file.isFolder) R.drawable.folder else getIconByExtension(file)
377 | )
378 | //Set Protected File.
379 | injector.image(
380 | R.id.protectedFile,
381 | if (file.isProtected) R.drawable.lock else 0
382 | )
383 | injector.image(
384 | R.id.itemSelectedFolder,
385 | if (file.isFolder && containsSelectedFile(file)) R.drawable.asterisk else 0
386 | )
387 | injector.using(R.id.fileIcon) { alpha = if (file.isHidden) 0.4f else 1f }
388 | injector.text(R.id.tvFileName, file.name)
389 | if (file.isFile) {
390 | injector.text(R.id.tvFileSize, file.sizeAsString)
391 | } else {
392 | val itemCount = file.count(chooserFileFilter)
393 | val stringRes =
394 | if (itemCount > 1) R.string.plural_items else R.string.singular_item
395 | injector.text(R.id.tvFileSize, context.getString(stringRes, itemCount))
396 | }
397 | injector.text(R.id.lastModificationDate, file.lastModified)
398 | injector.show(R.id.cbSelectFile, allowSelectFolder || file.isFile)
399 | injector.click(EasyAdapter.ROOT_VIEW) {
400 | goTo(file)
401 | }
402 | injector.using(R.id.cbSelectFile) {
403 | tag = file
404 | setOnCheckedChangeListener(null)
405 | isChecked = archivesList.contains(file)
406 | setOnCheckedChangeListener { buttonView, isChecked ->
407 | selectFile(buttonView, file, isChecked)
408 | }
409 | }
410 | }
411 | archivesListAdapter.mapEmpty(R.layout.dialog_empty_folder)
412 | mSwipeRefreshLayout.setOnRefreshListener {
413 | loadCurrentFolder()
414 | mSwipeRefreshLayout.isRefreshing = false
415 | }
416 | mSelectAll.setOnCheckedChangeListener { _, checked ->
417 | seletionStatus[file] = checked
418 | currentArchives.forEach {
419 | if (allowSelectFolder || !it.isFolder) {
420 | selectFile(null, it, checked)
421 | }
422 | }
423 | loadCurrentFolder()
424 | }
425 | mDirectoryPath.setBreadCrumbListener(object : BreadCrumbView.BreadCrumbListener {
426 | override fun onItemClicked(
427 | breadCrumbView: BreadCrumbView,
428 | breadCrumbItem: BreadCrumbItem,
429 | i: Int
430 | ) {
431 | goTo(breadCrumbItem.selectedItem)
432 | }
433 |
434 | override fun onItemValueChanged(
435 | breadCrumbView: BreadCrumbView,
436 | breadCrumbItem: BreadCrumbItem,
437 | i: Int,
438 | file: File,
439 | t1: File
440 | ): Boolean {
441 | return false
442 | }
443 | })
444 | mBack.setOnClickListener { back() }
445 | mHomeDirectory.setOnClickListener { goToStart() }
446 | mSearch.setOnClickListener {
447 | if (mSearchView.visibility == View.VISIBLE) {
448 | mSearchView.visibility = View.GONE
449 | } else {
450 | mSearchView.visibility = View.VISIBLE
451 | }
452 | }
453 | mSearchField.removeTextChangedListener(chooserTextWatcher)
454 | mSearchField.addTextChangedListener(chooserTextWatcher)
455 | archivesListAdapter.attachTo(mListFileFolders)
456 | //Create Folder.
457 | mCreateFolder.setOnClickListener {
458 | //Check If Write permission is granted
459 | if (ContextCompat.checkSelfPermission(
460 | context,
461 | Manifest.permission.WRITE_EXTERNAL_STORAGE
462 | ) != PackageManager.PERMISSION_GRANTED
463 | ) {
464 | Toast.makeText(context, "Please Grant Write Permission", Toast.LENGTH_SHORT)
465 | .show()
466 | return@setOnClickListener
467 | }
468 |
469 | MaterialDialog.Builder(context)
470 | .title(R.string.create_new_folder)
471 | .titleColor(titleTheme)
472 | .inputRangeRes(1, -1, R.color.input_out_of_range)
473 | .inputType(InputType.TYPE_CLASS_TEXT)
474 | .negativeText(android.R.string.cancel)
475 | .negativeColor(cancelTheme)
476 | .positiveColor(okTheme)
477 | .backgroundColor(this@KnotFileChooser.backgroundColor)
478 | .input(R.string.type_folder_name, 0, false) { _, input ->
479 | val newFolder = File(file, input.toString())
480 | try {
481 | if (!newFolder.mkdir()) {
482 | Toast.makeText(context, "error", Toast.LENGTH_SHORT).show()
483 | } else {
484 | loadCurrentFolder()
485 | }
486 | } catch (e: Exception) {
487 | Toast.makeText(context, "error: " + e.message, Toast.LENGTH_SHORT)
488 | .show()
489 | }
490 | }.show()
491 | }
492 | onPositive { dialog, _ ->
493 | //Two CallBack will be returned one for List of Files and other for List of File Uri
494 | //You have selected the minimum number of files..
495 | if (archivesList.size in minSelectedFiles..maxSelectedFiles) {
496 | onSelectedFilesListener(archivesList.toList())
497 | //Show directory Path if no file selected
498 | if (archivesList.size == 0) {
499 | archivesList.add(getPath())
500 | onSelectedFilesListener(archivesList.toList())
501 | }
502 | //Send File URI Callback
503 | val fileUri: MutableSet =
504 | Collections.newSetFromMap(ConcurrentHashMap())
505 | for (file in archivesList) {
506 | fileUri.add(Uri.fromFile(file))
507 | }
508 | onSelectedFileUriListener(fileUri.toList())
509 | //Close a dialog.
510 | dialog.dismiss()
511 | }
512 |
513 | }
514 | onNegative { dialog, _ ->
515 | if (!cancelable) {
516 | //You have selected the minimum amount of files.
517 | if (archivesList.size in minSelectedFiles..maxSelectedFiles) {
518 | //Dismiss a dialog.
519 | dialog.dismiss()
520 | }
521 | } else {
522 | dialog.dismiss()
523 | }
524 |
525 | }
526 | dismissListener {
527 | //
528 | //Saves the current folder if restoring folders is allowed.
529 | if (restoreFolder) {
530 | ChooserSharedPreference.setPreviouslySelectedDirectory(context, file)
531 | }
532 | }
533 | //Allows multiple selection.
534 | mSelectAll.visibility = if (allowMultipleFiles) View.VISIBLE else View.GONE
535 | //Allow create folder.
536 | dialog.mCreateFolder.visibility = if (allowCreateFolder) View.VISIBLE else View.GONE
537 |
538 | //Start.
539 | displayQuantityOfSelectedItems(0)
540 | loadCurrentFolder()
541 | }
542 |
543 | fun displayQuantityOfSelectedItems(size: Long) {
544 | //Updates the number of folders selected by plurality.
545 | if (archivesList.size > 1) {
546 | dialog.mQuantityItemsSelected.text =
547 | context.getString(
548 | R.string.plural_selected_items,
549 | archivesList.size,
550 | size.toSizeString()
551 | )
552 | } else {
553 | dialog.mQuantityItemsSelected.text =
554 | context.getString(
555 | R.string.singular_selected_item,
556 | archivesList.size,
557 | size.toSizeString()
558 | )
559 | }
560 | }
561 |
562 | fun getPath(): File {
563 | val path = StringBuilder()
564 | for (i in 1 until mDirectoryPath.itens.size) {
565 | path.append("/" + mDirectoryPath.itens[i].text)
566 | }
567 | return File("$path")
568 | }
569 |
570 | private fun containsSelectedFile(parent: File): Boolean {
571 | for (file in archivesList) {
572 | if (file.absolutePath != parent.absolutePath &&
573 | file.absolutePath.startsWith(parent.absolutePath)
574 | ) {
575 | return true
576 | }
577 | }
578 | return false
579 | }
580 |
581 | private fun getIconByExtension(file: File): Int {
582 | return when (file.extension) {
583 | "mp4" -> R.drawable.video
584 | "c", "cpp", "cs", "js", "h", "java", "kt", "php", "xml" -> R.drawable.code
585 | "avi" -> R.drawable.avi
586 | "doc" -> R.drawable.doc
587 | "flv" -> R.drawable.flv
588 | "jpg", "jpeg" -> R.drawable.jpg
589 | "json" -> R.drawable.json
590 | "mov" -> R.drawable.mov
591 | "mp3" -> R.drawable.mp3
592 | "pdf" -> R.drawable.pdf
593 | "txt" -> R.drawable.txt
594 | "db" -> R.drawable.db_file
595 | else -> R.drawable.archive
596 | }
597 | }
598 | }
599 |
600 | //Item for root folder.
601 | private class RootFileBreadCrumbItem(file: File) : FileBreadCrumbItem(file) {
602 |
603 | override fun getText() = "/"
604 | }
605 |
606 | //Item for a folder.
607 | private open class FileBreadCrumbItem(file: File) : BreadCrumbItem() {
608 |
609 | init {
610 | itens = listOf(file)
611 | }
612 |
613 | override fun getText(): String? = selectedItem.name
614 | }
615 |
616 | //File Filter.
617 | private inner class ChooserFileFilter : FileFilter {
618 |
619 | override fun accept(f: File): Boolean {
620 | val showHidden = showHiddenFiles || !f.isHidden
621 | return (searchText.isEmpty() || f.name.contains(searchText, true)) &&
622 | //It is a hidden file and can be displayed.
623 | showHidden &&
624 | //View files and / or folders.
625 | (showFiles && f.isFile || showFolders && f.isFolder) &&
626 | //Filters.
627 | filter(f)
628 | }
629 |
630 | private fun filter(f: File): Boolean {
631 | //No filters.
632 | if (filters.size == 0) return true
633 | //Filters.
634 | for (filter in filters) {
635 | if (filter.accept(f)) {
636 | return true
637 | }
638 | }
639 | return false
640 | }
641 | }
642 |
643 |
644 | private inner class ChooserTextWatcher : TextWatcher {
645 |
646 | override fun afterTextChanged(s: Editable) {
647 | searchText = s.toString().toLowerCase()
648 | loadCurrentFolder()
649 | }
650 |
651 | override fun beforeTextChanged(s: CharSequence, start: Int, count: Int, after: Int) {
652 | }
653 |
654 | override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {
655 | }
656 | }
657 |
658 | }
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------