Document collaboration systems allow multiple clients to edit a single document or file to achieve a final version of the document or file. Although various technologies have been implemented in such systems, two well-known, yet flawed, approaches have been identified. The first approach is to merge small custom records with the changes of other client through operational transformation. This approach allows for rapid change propagation, but results in poor scaling of the system's logical complexity in terms of complex documents and voluminous operations. The second approach is to send an entire new copy of the document to a receiving client and allow the receiving client to determine the changes to be merged by comparing the new document against a baseline copy of the document. This approach adequately allows for scaling of the system's logical complexity, but does not provide for rapid change propagations.
It is with respect to these and other general considerations that the aspects disclosed herein have been made. Also, although relatively specific problems may be discussed, it should be understood that the examples should not be limited to solving the specific problems identified in the background or elsewhere in this disclosure.
This summary is provided to introduce a selection of concepts in a simplified form that are further described below in the Detail Description section. This summary is not intended to identify key features or essential features of the claimed subject matter, nor is it intended to be used as an aid in determining the scope of the claimed subject matter.
The present disclosure provides methods, systems, and computer products for providing state-based revisions in a document collaboration system. In some aspects, a plurality of users may be simultaneously editing the same document on their respective computing devices. The document may comprise a plurality of editable objects having unique objects identifiers. For example, a document may have a chart object, a conditional formatting rule object and a hidden row/column object, each of which is assigned a unique identifier. In some aspects, when a user edits an object in a local version of the document, a state-based revision (“SBR”) record is created. As used herein, a SBR record refers to a record consisting of a header section and a body section. The header section contains information describing the type of object being edited, a descriptor that uniquely identifies the specific instance of the object being edited and a collection of common references that can be adjusted by the document collaboration engine. The body section contains an opaque binary stream comprising the modified state of the edited object. The SBR record is then transmitted to one or more additional devices.
These and other features and advantages, which character the present non-limiting aspects, will be apparent from a reading of the following detailed description and a review of the associated drawings. It is to be understood that both the foregoing general description and the following detailed description are explanatory only and are not restrictive of the non-limiting aspects as claimed.
Non-limiting and non-exhaustive aspects are described with reference to the following Figures in which:
Various aspects of the disclosure are described more fully below with reference to the accompanying drawings, which form a part hereof, and which show specific exemplary aspects. However, different aspects of the disclosure may be implemented in many different forms and should not be construed as limited to the aspects set forth herein; rather, these aspects are provided so that this disclosure will be thorough and complete, and will fully convey the scope of the aspects to those skilled in the art. Aspects may be practiced as methods, systems or devices. Accordingly, aspects may take the form of a hardware implementation, an entirely software implementation or an implementation combining software and hardware aspects. The following detailed description is, therefore, not to be taken in a limiting sense.
The present disclosure provides methods, systems, and computer products for providing state-based revisions in a document collaboration system. In examples, a plurality of users may be simultaneously editing the same document on their respective computing devices. A computing device, as used herein, may refer to computing hardware or software components. For example, a computing device may be personal computer, a laptop, a tablet computing device, a mobile computing device such as, for example, a smartphone or a phablet, one more software applications and/or a set of instructions. The document may comprise a plurality of editable objects having unique objects identifiers. For example, a document may have a chart object, a conditional formatting rule object and a hidden row/column object, each of which is assigned a unique identifier. In examples, when a user edits an object in a local version of the document, a state-based revision (“SBR”) record is created. Generally, a SBR record is created when a modification occurs in a document. A SBR record may be contain the modified state of a portion of a document and may be used to effectively communicate modifications to the document by a user to other participating users of a document collaboration system. A SBR may also contain references from the content contained within the SBR record. By transmitting a SBR record to participating users, the participating users may enjoy rapid change propagation during collaboration.
In certain aspects, a SBR record consists of a header section and a body section. Generally, a header is data placed at or near the beginning of a message or a block of data. For example, a header may be an email header, a data packet header, a programming language header file or the like. In the aspects disclosed herein, a header may be a first container within the SBR record. In those aspects, the header section contains information describing the type of object being edited, a descriptor that uniquely identifies the specific instance of the object being edited and a collection of common references that can be adjusted by the document collaboration engine. A body section generally is a portion of data within a message or a block of data. For example, the body section of an email message may contain the text, images and/or links to be communicated to the recipient. In the aspects disclosed herein, the body section may be a second container within the SBR record and may contain an opaque binary stream comprising the modified state of the edited object. After the header section and body section have been populated, the SBR record may be transmitted to one or more additional devices.
In such examples, upon receipt of an SBR record comprising an edit to a remote version of a document, a determination may be made as to whether edits to the local version of the document have been performed. A “document” may include, but is not limited to, a word processing document, a worksheet, a presentation, a workflow project, a web page, etc. A local edit may be a modification to a local version of a document. A local edit may be performed from a local computing device or from a remote computing device that is accessing a document on a local computing device. If local edits have been performed, operational transforms (“OT”) may be performed on the SBR record header accordingly. Generally, an operational transform is method for supporting a range of collaborative functionalities. For example, an OT may be used to enforce consistency maintenance and/or concurrency control in collaborative editing of text documents. After the OTs have been performed, or if local edits have not been performed, the SBR record header is analyzed to identify the object within the SBR record. If the object within the SBR record exists within the local version of the document, the object and information describing the object are identified within the local version of the document. The modified object state within the body of the SBR record is then loaded to the identified local object. In certain examples, the modified object state may represent a deletion operation. In such examples, the deletion operation is performed on the identified local object. If the object within the SBR record does not exist within the local version of the document, the object is created within the local version of the document and the modified object state within the body of the SBR record is loaded to the created local object.
Although
Header section 115 may comprise information identifying the type of object being edited 117, a descriptor that uniquely identifies the specific instance of the object being edited 119 and/or one or more virtualized references to content that is outside of the state of the object 121. Generally, an object type is a data type used in object-oriented programming to wrap a non-object/primitive type. Object type may represent a data structure, functions and/or procedures to manipulate the data. In some aspects, Information 117 may indicate data structure, functions and/or procedures associated with an edited object. A virtualized reference generally refers to a virtual token used to replace data and/or other content associated with a document and/or object. For instance, the virtual token ‘text’ may be used to represent the entire body of an email message. To continue with the above example, the SBR header created by the user's revision may indicate an object type identifier of ‘Data Validation’, an object identifier of ‘Data_Validation_Rule_1’ and a virtualized cell reference of the affected data range, e.g., ‘ref1=C3:D4’. In some aspects, because header section 115 may comprise the virtualized references to external content, the virtual references may be updated and/or modified within OTs while maintaining the immutable status of the external content.
Body section 125 may refer to a portion of data within a message or a block of data. For example, the body section may be a second container within the SBR record and may be populated with information upon creation or when the SBR record is received by the user computing device. In some aspects, body section 125 may comprises an opaque binary stream comprising the modified state of the edited object 127. A binary stream may consist of one or more bytes of data. In some aspects, an object or data associated with an edited object may be serialized into a binary stream representing the object or associated object data. Further continuing with the above example, the SBR body created by the user's revision may contain a binary stream of information indicating that the edit ‘Applies to range ref1’, ‘Criteria: Number>3’ and ‘Error String: Invalid Input’.
At operation 350, the body section is populated. In some examples, the modified state of the edited object is passed directly into the document collaboration infrastructure. In other examples, the document collaboration infrastructure may use the information within the call to perform a separate call to feature code. For example, information within the call may identify the feature to request and/or which specific object to request. The feature code may then populate the body section with the modified state of the edited object. After the body section is populated, the content of the body section is serialized into a data stream containing the revision. During serialization, references to content outside of the edited object's state may be detected and replaced with a unique identifier, a virtualized token and/or the like. This virtual tokenization of references provides a layer of indirection between the object state that contains the reference and the reference itself, which allows for modification of the reference without requiring knowledge of the object the reference is within. The mappings between the virtualized tokens and their corresponding references may further populate the header section. In certain aspects, the body section may be populated with a null object to indicate the deletion or an object or the removal of an object state.
At operation 420, a corresponding SBR record may be created if the local edits result in a state-based change to an object in the Device B version of the document. If the local changes do not result in a state-based change to an object in the Device B version of the document, the local changes may simply be applied. OTs may then be performed on the received SBR header to reflect the local changes applied to the Device B version of the document. Consider the following example: In response to User A adding data validation identified as ‘DV1’ onto cell D13 of document X, a SBR is produced with the header ‘DV1’. When serializing ‘DV1’, cell D13 is identified as a reference external to the data validation and is tokenized as ‘ref1’. Simultaneously, User B inserts a row into document X above row 13. When User B receives User A's SBR record, User B performs an OT on the SBR record. As the reference to D13 is stored in the header, it is visible to the OT method, which may adjust it to D14 to account for the row inserted by User B. After the OT is complete, User A's SBR record specifies an edit to object ‘DV1’ and the header includes a mapping of ‘ref1’ to D14. In operation 415, the SBR record is analyzed in order to identify the edited object. Analyzing the SBR record includes parsing the header to extract information relating to the edited object. In determination 430, a determination is made as to whether the object identified in the SBR record header exists in the Device B version of the document. If the object exists in the Device B version of the document, the object and information associated with the object are identified in operation 435. The flow proceeds to 445. If the object does not exist in the Device B version of the document, an instance of the object is created at flow 440. In operation 445, the identified or created object is loaded with the edited and adjusted object state in the SBR record body. The flow then terminates.
The examples and functionalities described herein may operate via a multitude of computing systems including, without limitation, desktop computer systems, wired and wireless computing systems, mobile computing systems (e.g., mobile telephones, netbooks, tablet or slate type computers, notebook computers, and laptop computers), hand-held devices, multiprocessor systems, microprocessor-based or programmable consumer electronics, minicomputers, and mainframe computers.
In addition, the examples and functionalities described herein may operate over distributed systems (e.g., cloud-based computing systems), where application functionality, memory, data storage and retrieval and various processing functions may be operated remotely from each other over a distributed computing network, such as the Internet or an intranet. User interfaces and information of various types may be displayed via on-board computing device displays or via remote display units associated with one or more computing devices. For example user interfaces and information of various types may be displayed and interacted with on a wall surface onto which user interfaces and information of various types are projected. Interaction with the multitude of computing systems with which examples of the present disclosure may be practiced include, keystroke entry, touch screen entry, voice or other audio entry, gesture entry where an associated computing device is equipped with detection (e.g., camera) functionality for capturing and interpreting user gestures for controlling the functionality of the computing device, and the like.
As stated above, a number of program modules and data files may be stored in the system memory 504. While executing on the processing unit 502, the program modules 506 may perform processes including, but not limited to, one or more of the stages of the operational flows 200-400 illustrated in
Furthermore, examples of the present disclosure may be practiced in an electrical circuit comprising discrete electronic elements, packaged or integrated electronic chips containing logic gates, a circuit utilizing a microprocessor, or on a single chip containing electronic elements or microprocessors. For example, examples of the present disclosure may be practiced via a system-on-a-chip (SOC) where each or many of the components illustrated in
The computing device 1100 may also have one or more input device(s) 512 such as a keyboard, a mouse, a pen, a sound input device, a touch input device, etc. The output device(s) 514 such as a display, speakers, a printer, etc. may also be included. The aforementioned devices are examples and others may be used. The computing device 1100 may include one or more communication connections 516 allowing communications with other computing devices 518. Examples of suitable communication connections 516 include, but are not limited to, RF transmitter, receiver, and/or transceiver circuitry; universal serial bus (USB), parallel, and/or serial ports.
The term computer readable media as used herein may include computer storage media. Computer storage media may include volatile and nonvolatile, removable and non-removable media implemented in any method or technology for storage of information, such as computer readable instructions, data structures, or program modules. The system memory 504, the removable storage device 509, and the non-removable storage device 510 are all computer storage media examples (i.e., memory storage.) Computer storage media may include RAM, ROM, electrically erasable read-only memory (EEPROM), flash memory or other memory technology, CD-ROM, digital versatile disks (DVD) or other optical storage, magnetic cassettes, magnetic tape, magnetic disk storage or other magnetic storage devices, or any other article of manufacture which can be used to store information and which can be accessed by the computing device 1100. Any such computer storage media may be part of the computing device 1100. Computer storage media does not include a carrier wave or other propagated or modulated data signal.
Communication media may be embodied by computer readable instructions, data structures, program modules, or other data in a modulated data signal, such as a carrier wave or other transport mechanism, and includes any information delivery media. The term “modulated data signal” may describe a signal that has one or more characteristics set or changed in such a manner as to encode information in the signal. By way of example, and not limitation, communication media may include wired media such as a wired network or direct-wired connection, and wireless media such as acoustic, radio frequency (RF), infrared, and other wireless media.
One or more application programs 666 may be loaded into the memory 662 and run on or in association with the operating system 664. Examples of the application programs include phone dialer programs, e-mail programs, personal information management (PIM) programs, word processing programs, spreadsheet programs, Internet browser programs, messaging programs, and so forth. The system 602 also includes a non-volatile storage area 668 within the memory 662. The non-volatile storage area 668 may be used to store persistent information that should not be lost if the system 602 is powered down. The application programs 666 may use and store information in the non-volatile storage area 668, such as e-mail or other messages used by an e-mail application, and the like. A synchronization application (not shown) also resides on the system 602 and is programmed to interact with a corresponding synchronization application resident on a host computer to keep the information stored in the non-volatile storage area 668 synchronized with corresponding information stored at the host computer. As should be appreciated, other applications may be loaded into the memory 662 and run on the mobile computing device 600 described herein.
The system 602 has a power supply 670, which may be implemented as one or more batteries. The power supply 670 might further include an external power source, such as an AC adapter or a powered docking cradle that supplements or recharges the batteries.
The system 602 may also include a radio 672 that performs the function of transmitting and receiving radio frequency communications. The radio 672 facilitates wireless connectivity between the system 602 and the “outside world,” via a communications carrier or service provider. Transmissions to and from the radio 672 are conducted under control of the operating system 664. In other words, communications received by the radio 672 may be disseminated to the application programs 666 via the operating system 664, and vice versa.
The visual indicator 620 may be used to provide visual notifications, and/or an audio interface 674 may be used for producing audible notifications via the audio transducer 625. In the illustrated embodiment, the visual indicator 620 is a light emitting diode (LED) and the audio transducer 625 is a speaker. These devices may be directly coupled to the power supply 670 so that when activated, they remain on for a duration dictated by the notification mechanism even though the processor 660 and other components might shut down for conserving battery power. The LED may be programmed to remain on indefinitely until the user takes action to indicate the powered-on status of the device. The audio interface 674 is used to provide audible signals to and receive audible signals from the user. For example, in addition to being coupled to the audio transducer 625, the audio interface 674 may also be coupled to a microphone to receive audible input, such as to facilitate a telephone conversation. In accordance with examples of the present disclosure, the microphone may also serve as an audio sensor to facilitate control of notifications, as will be described below. The system 602 may further include a video interface 676 that enables an operation of an on-board camera 630 to record still images, video stream, and the like.
A mobile computing device 600 implementing the system 602 may have additional features or functionality. For example, the mobile computing device 600 may also include additional data storage devices (removable and/or non-removable) such as, magnetic disks, optical disks, or tape. Such additional storage is illustrated in
Data/information generated or captured by the mobile computing device 600 and stored via the system 602 may be stored locally on the mobile computing device 600, as described above, or the data may be stored on any number of storage media that may be accessed by the device via the radio 672 or via a wired connection between the mobile computing device 600 and a separate computing device associated with the mobile computing device 600, for example, a server computer in a distributed computing network, such as the Internet. As should be appreciated such data/information may be accessed via the mobile computing device 600 via the radio 672 or via a distributed computing network. Similarly, such data/information may be readily transferred between computing devices for storage and use according to well-known data/information transfer and storage means, including electronic mail and collaborative data/information sharing systems.
Among other examples, the present disclosure presents systems and methods for performing state-based revisions in document collaboration systems, comprising: initiating, on a first computing device, a document editing session for a local version of a document; creating a state-based revision, wherein the state-based revision comprises: the at least one modification; and a virtualized reference to content associated with the at least one modification; and sending the state-based revision to a second computing device. In further examples, the at least one modification identifies a modification to an object within the document. In further examples, the state-based revision further comprises a header section and a body section. In further examples, the header section comprises at least one of information identifying the type of the object being modified, a unique descriptor identifying the object being modified and a reference to content peripheral to the state of the object. In further examples, the header section is object-independent. In further examples, the body section comprises the at least one modification. In further examples, the at least one modification is serialized into a data stream, wherein serializing the at least one modification comprises detecting whether content peripheral to the state of the object is present. In further examples, when content peripheral to the state of the object is detected, replacing the content with a reference to the content, wherein the reference to the content is at least one of a unique identifier and a virtualized token.
Further aspects disclosed herein provide a computer-readable media storing computer executable instructions that when executed cause a computing system to produce a state-based revision record associated with an object, the state-based revision record comprising: a generalized header section, wherein the generalized header section is object independent, and wherein the generalized header section comprises: information identifying an object type for the object; and at least one virtualized reference to a portion of the object; and a body section, wherein the body section comprises the at least one modification. In further examples, the generalized header section further comprises a unique descriptor of the object being modified. In further examples, the at least one virtualized reference represents an immutable status of the object. In further examples, the at least one virtualized reference is capable of modification within an operational transform. In further examples, the at least one modification identifies a modification to the object. In further examples, the at least one modification is serialized into a data stream, wherein serializing the at least one modification comprises detecting whether a portion of the object is peripheral to the state of the object. In further examples, when the portion of the object is peripheral to the state of the object, the portion of the object is replaced with a virtualized reference to the portion of the object.
Additional aspects disclosed herein provide a document collaboration system for performing state-based revisions, the document collaboration system comprising: a computing device, comprising a processor; and memory coupled to the processor, the memory comprising computer executable instructions that, when executed by the processor performs a method comprising: separating a first document into a plurality of object chunks, wherein plurality of object chunks comprises a first object chunk in the plurality of object chunks is associated with a first object state; editing the document, wherein editing the document produces at least one modification to the first object chunk; and creating a state-based revision, wherein the state-based revision comprises: the at least one modification to the first object chunk; and a virtualized reference to content associated with the first object chunk. In further examples, the state-based revision further comprises a header section and a body section. In further examples, the header section comprises at least one of information identifying the type of the object associated with the first object chunk, a unique descriptor identifying the object chunk and a reference to content peripheral to the state of the object chunk. In further examples, the body section comprises the at least one modification to the object chunk. In further examples, the header section is object-independent.
Additional aspects disclosed herein provide a document collaboration means for performing state-based revisions, the document collaboration system comprising: a computing device, comprising a processor; and memory coupled to the processor, the memory comprising computer executable instructions that, when executed by the processor performs a method comprising: separating a first document into a plurality of object chunks, wherein plurality of object chunks comprises a first object chunk in the plurality of object chunks is associated with a first object state; editing the document, wherein editing the document produces at least one modification to the first object chunk; and creating a state-based revision, wherein the state-based revision comprises: the at least one modification to the first object chunk; and a virtualized reference to content associated with the first object chunk. In further examples, the state-based revision further comprises a header section and a body section. In further examples, the header section comprises at least one of information identifying the type of the object associated with the first object chunk, a unique descriptor identifying the object chunk and a reference to content peripheral to the state of the object chunk. In further examples, the body section comprises the at least one modification to the object chunk. In further examples, the header section is object-independent.
Examples of the present disclosure, for example, are described above with reference to block diagrams and/or operational illustrations of methods, systems, and computer program products according to examples of the present disclosure. The functions/acts noted in the blocks may occur out of the order as shown in any flowchart. For example, two blocks shown in succession may in fact be executed substantially concurrently or the blocks may sometimes be executed in the reverse order, depending upon the functionality/acts involved.
The description and illustration of one or more examples provided in this application are not intended to limit or restrict the scope of the present disclosure as claimed in any way. The examples, examples, and details provided in this application are considered sufficient to convey possession and enable others to make and use the best mode of the claimed examples. The claimed examples should not be construed as being limited to any embodiment, example, or detail provided in this application. Regardless of whether shown and described in combination or separately, the various features (both structural and methodological) are intended to be selectively included or omitted to produce an embodiment with a particular set of features. Having been provided with the description and illustration of the present application, one skilled in the art may envision variations, modifications, and alternate examples falling within the spirit of the broader aspects of the general inventive concept embodied in this application that do not depart from the broader scope of the claimed examples.