• Introduction
• installation
  • Install the server on the Raspberry Pi
  • Install the server on other operating systems
  • Install the client on iOS
• App Configuration File
• Scan data (additional function)
• iSyncServer Source Description
  • Database Table Structure Description
  • API Interface Description
    • Responds Format
    • Type Definition
  • Account related interface
    • login.icc
    • logout.icc
  • HelpInfo related interface
    • helpInfo.icc
    • updateHelpInfo.icc
  • Catalog related interface
    • catalogs.icc
    • createCatalog.icc
    • deleteCatalog.icc
    • updateCatalog.icc
  • File related interface
    • files.icc
    • thumbnail.icc
    • downFile.icc_ext
    • shareFileUrl.icc
    • shareFile.icc_ext
    • uploadFileInfo.icc
    • uploadingInfo.icc
    • uploadFile.icc
    • deleteFiles.icc
    • updateFile.icc

中文说明

Introduction

With Raspberry Pi, through the HTTP protocol on the mobile hard disk to operate. Scan the specified file path and write to the database, providing a series of API interfaces to add or delete or modify or search.Family members easy access to their media files

Server need install:pyenv, python3, flask. If you need to generate thumbnails of media files, get the media file information, you need to install: ffmpeg, Pillow

Client need to implement the following API interfaces as needed.Has provided the iOS client: iPrivate

Take a picture to see the effect On the left is the effect on the iphone, the right is in the raspberry side of the effect

Let’s take a look at my video, click open

installation

iSyncServer source is hosted on github and coding

Install the server on the Raspberry Pi

Recommended downloadRASPBIAN LITE

Use the following shell script to install automatically( the Script only test on Raspberry pi lite) The script will automatically update the operating system and install the software: git, ffmpeg, pyenv, python 3.5.2, pyenv-virtual of iSyncServerEnv3.5.2, Pillow, Flask. And will add auto run when boot

When the shell is timeout, you can try it again or enter ~/iSyncServer and run ./run.sh

curl "https://raw.githubusercontent.com/jxd524/iSyncServer/master/run.sh" > ~/setup_iSyncServer.sh && bash ~/setup_iSyncServer.sh ; rm ~/setup_iSyncServer.sh

Install the server on other operating systems

1. Install git
2. Install ffmpeg(Optional operation, if not installed, iSyncServer can not generate video thumbnails)
3. Install pyenv, pyenv-virtualenv.help of pyenv and help of pyenv-virtualenv
4. Used pyenv create python 3.5.2 virtual: iSyncServerEnv3.5.2
5. Install Pillow, Flask in the virtual environment iSyncServerEnv3.5.2
6. Copy the iSyncServer Source code to local:~/iSyncServer .
7. Config scanDiskConfig.json. Refer to
8. Config appConfigs.json. Refer to
9. Option. Run scanDisk.py in the virtual environment iSyncServerEnv3.5.2. python scanDisk.py
10. Run app.py in the virtual environment iSyncServerEnv3.5.2. python app.py

Install the client on iOS

Install iPrivate Open the app and go to remote ui then input server addr. like http://192.168.1.188:5000

App Configuration File

Create a configuration file named appConfigs.json in the root directory. It will affect the entire server. If there is no configuration file, the default value is used

• logFileName: log file path. Default: ./building/appLog.log
• thumbPath: The root path when the thumbnail is generated. Default ./building/thumbs
• defaultUserPath: The default user path is only required when creating a user, but this user does not have a directory. Default: ./building/users
• shareUrlThreshold: Share the maximum number of URLs. Default: 1000,
• shareUrlTimeout: Share the maximum cache time for the URL. Default: 1800. unit:second
• onlineThreshold: The number of online extreme value, exceeds this value, it will be time-out processing. Defalt: 100
• onlineTimeout: Online users have no activity to keep the maximum time. Default: 3600, Unit: second

Can used configs.py, configs.py support for the following fields, as in the following example

python configs.py --onlineThreshold=500 --thumbPath=/Users/terry/work/thumbPaths

You can also directly edit the appConfigs.json file under the source root directory. (If it does not exist, then directly created), the following example

{
    "onlineThreshold": 500,
    "onlineTimeout": 8000,
    "thumbPath": "/Users/terry/work/thumbPaths"
}

Scan data (additional function)

In order to facilitate the processing of disk data, provided scanDisk.py to recursively scan the specified directory, the corresponding file and user information written to the database The configuration file is a JSON file. The outer layer is an array, each object has paths and users properties

users: Dictionary type, definition of user name and password paths: An array containing strings that defines the path information to be scanned mergeRootPaths: Merge the root directory, the path has been scanned into the database to determine, to prevent too many root directory. Default: 1

In general, you only need to write the configuration file according to the requirements, and then run the python scanDisk.py on it. If any file changes, you only need to run the order once again to solve the problem.

See the table below for specific parameters

Execute the command example

#Scan data according to scanConfig.json in the same directory
python scanDisk.py

#Use the configuration file sd.json to scan the data
python scanDisk.py -i sd.json

#Incremental scan
python scanDisk.py -p /User/Terry/syncFiles/t2

Configuration file example

[
    {
        "paths":["~/work/temp/sharePath", "~/Downloads"],
        "users":[
            {"name": "terry", "password": "123"},
            {"name": "terry2", "password": "333"}
        ],
        "mergeRootPaths": 1
    },
    {
        "paths":["/User/Terry/syncFiles/t1"],
        "users":[
            {"name": "terry"}
        ]
    },
    {
        "paths":["/User/Terry/syncFiles/t2"],
        "users":[
            {"name": "terry2"}
        ]
    }
]

iSyncServer Source Description

If you are interested the source code, or want to develop a new iSyncServer client. You need to look it down. Here the iSyncServer database and source, provide some of the interface to introduce

Database Table Structure Description

Server use python built-in support for the database: sqlite3. Only four tables to record the data, the specific definition, you can refer to the source code.

1. User: user table
2. Catalog: catalog table
3. Files: file table
4. UserAssociate: User and Catalog relationship table, record the user has read and write operations of the root directory information

For the first three tables, there are HelpInfo information, which is meaningless to the server. Only meaningful to the client, the client can be given different needs according to the needs.

API Interface Description

Define the request and response of the interface, if not

1. Both the request and the response interact through the JSON format
2. Interface need to login before use

Responds Format

{
    "code": 0,
    "msg": "error message.",
    "data": "Different commands have different structures"
}

Type Definition

datetime:Include the type of date and time 1970 to the present number of seconds, such as 2017-04-19 03:06:44 +0000 expressed as: 1492571204

typedef datetime int

orientation: The rotation of a picture or video In the generation of thumbnails will be used, the database records the original direction, if 0, that does not need to rotate

Corresponding relationship with UIImageOrientation in iOS

fileStatus: File status Whether the file exists, use the state of scanDisk: kFileStatusFromLocal When the server needs to generate thumbnails, the corresponding field needs to be set to kFileStatusFromLocal, otherwise no thumbnail generation

kFileStatusFromLocal        = 0 # From the local
kFileStatusBuildError       = 1 # Server can not build
kFileStatusFromUploading    = 2 # From uploading
kFileStatusFromUploaded     = 3 # From upload, and has been complete

Files Table Field Description: √ Indicates possible values

fileType: Media type definition

kFileTypeImage      = 1 << 0
kFileTypeGif        = 1 << 1
kFileTypeVideo      = 1 << 2
kFileTypeAudio      = 1 << 3
kFileTypeFile       = 1 << 4

HelpInfo: The server is only responsible for saving, meaningless to the server

{
    "helpInt": 12,
    "helpText": "xxxx",
    "lastModifyTime": 1480665083.080785
}

UserInfo: User Info

{
    "id": 12,
    "name": "displayName",
    "createTime": 123123123.00,
    "lastLoginDate": 1480665083.080785,
    "helpInt": 20,
    "helpText": "only for client"
}

CatalogInfo: Catalog Info

{
    "id": 123,
    "rootId": 1,
    "parentId": 1,
    "name": "display name",
    "createTime": 123123.123,
    "lastModifyTime": 12312312.123,
    "memo": "xxx",
    "subCatalogCount": 0,
    "fileCount": 100,
    "helpInt": 123,
    "helpText": "only for client"
}

FileInfo: File info

{
    "id": 123,
    "uploadUserId": 1,
    "catalogId": 1,
    "name": "display name",
    "ext": "mp4",
    "createTime": 123123,
    "uploadTime": 3243423,
    "importTime": 98123,
    "lastModifyTime": 1231.12,
    "size": 123123,
    "type": 0,
    "duration": 1231.12,
    "width": 300,
    "height": 400,
    "orientation": 0,
    "memo": "jjjj",
    "helpInt": 12,
    "helpText": "XXXX",
    "uploadingThumbSize": 0,
    "uploadingScreenSize": 0,
    "uploadingOriginSize": 0
}

PS:

• uploadingThumbSize: Indicates the size of the thumbnail that has been uploaded
• uploadingScreenSize: Large thumbnail
• uploadingOriginSize: Original file The above three parameters will only be returned if the file has not been uploaded successfully. After the client has uploaded the file information, before uploading the contents of the file, you can get the number of bytes have been uploaded, And then upload the follow-up content. Reference Api: uploadFileInfo, uploadFile

PageInfo: Paging information

{
    "pageIndex": 0,
    "maxPerPage": 10,
    "pageCount": 100
}

Account related interface

login.icc

login to server

logout.icc

logout server

HelpInfo related interface

helpInfo.icc

Gets the auxiliary information for the specified record

updateHelpInfo.icc

Set the auxiliary information for the specified record

Catalog related interface

catalogs.icc

Gets the information in the specified directory

createCatalog.icc

create catalog

deleteCatalog.icc

updateCatalog.icc

File related interface

files.icc

get file list

Will return file list with fileStatus is kFileStatusFromLocal or kFileStatusFromUploaded

sort

fileResponse

{ “list”: [{fileInfo}], “page”: {pageInfo} }

thumbnail.icc

get file thumbnail

This interface will determine the relevant fileStatus to confirm whether to automatically generate thumbnails. In the upload interface need to set statusForThumb, statusForScreen

thumbnail information

fileStatus Description

downFile.icc_ext

Support breakpoint download. only single Range _ext: Indicates the extension, which is modified for iOS online play. It does not participate in the calculation, just a form of URL

The following two ways are possible:

downFile.icc?id=12

downFile.icc.mp4?id=12

shareFileUrl.icc

Gets the shared HTTP address for the specified resource

{
    "shareKey"
}

shareFile.icc_ext

Support breakpoint download. only single Range Get the share file content This interface does not need login

_ext: like downFile.icc

The following two ways are possible:

shareFile.icc.mp4?shareKey=xxxx

shareFile.icc.mov?shareKey=xxx

uploadFileInfo.icc

Upload the file, the first upload their information, and then upload the contents of the file

uploadingInfo.icc

Get the information of currently uploading

uploadFile.icc

upload file content

uploadResponse

{ “fileInfo”: {fileInfo}, “check”: {“origin”: “sha1 or md5 or none value”, “thumb”: “xxx”, “screen”: “xxx”} }

deleteFiles.icc

updateFile.icc

| Request method | POST | | ——– | — | ||| | Request parameter | Type | Description | | id | int | file id | | catalogId | int | opt. new catalog id. only change db info. | | name | string | opt, fiile display name | | size | int | opt. file size | | type | fileType | opt | | ext | string | opt | | statusForThumb | int | opt | | statusForScreen | int | opt | | createTime | datetime | opt | | importTime | datetime | opt | | lastModifyTime | datetime | opt | | duration | float | opt. only effect when file is gif or video | | longitude | double | opt | | latitude | double | opt | | width | int | opt | | height | int | opt | | orientation | int | opt | | memo | string | opt. len limit: 1024 | | helpInt | int | opt | | helpText | string | opt | ||| | Reponse Data | FileInfo | The script will automatically update the operating system and install the software: git, ffmpeg, pyenv, python 3.5.2, pyenv-virtual of iSyncServerEnv3.5.2, Pillow, Flask